aws-sdk-kendra 1.21.0 → 1.26.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.
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -61,7 +61,7 @@ module Aws::Kendra
61
61
  # A list of groups, separated by semi-colons, that filters a query
62
62
  # response based on user context. The document is only returned to
63
63
  # users that are in one of the groups specified in the `UserContext`
64
- # field of the Query operation.
64
+ # field of the `Query` operation.
65
65
  # @return [String]
66
66
  #
67
67
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AclConfiguration AWS API Documentation
@@ -500,7 +500,7 @@ module Aws::Kendra
500
500
  # document_id_list: ["DocumentId"], # required
501
501
  # data_source_sync_job_metric_target: {
502
502
  # data_source_id: "DataSourceId", # required
503
- # data_source_sync_job_id: "DataSourceSyncJobId", # required
503
+ # data_source_sync_job_id: "DataSourceSyncJobId",
504
504
  # },
505
505
  # }
506
506
  #
@@ -541,7 +541,7 @@ module Aws::Kendra
541
541
  end
542
542
 
543
543
  # Provides information about documents that could not be removed from an
544
- # index by the BatchDeleteDocument operation.
544
+ # index by the `BatchDeleteDocument` operation.
545
545
  #
546
546
  # @!attribute [rw] id
547
547
  # The identifier of the document that couldn't be removed from the
@@ -568,6 +568,103 @@ module Aws::Kendra
568
568
  include Aws::Structure
569
569
  end
570
570
 
571
+ # @note When making an API call, you may pass BatchGetDocumentStatusRequest
572
+ # data as a hash:
573
+ #
574
+ # {
575
+ # index_id: "IndexId", # required
576
+ # document_info_list: [ # required
577
+ # {
578
+ # document_id: "DocumentId", # required
579
+ # attributes: [
580
+ # {
581
+ # key: "DocumentAttributeKey", # required
582
+ # value: { # required
583
+ # string_value: "DocumentAttributeStringValue",
584
+ # string_list_value: ["String"],
585
+ # long_value: 1,
586
+ # date_value: Time.now,
587
+ # },
588
+ # },
589
+ # ],
590
+ # },
591
+ # ],
592
+ # }
593
+ #
594
+ # @!attribute [rw] index_id
595
+ # The identifier of the index to add documents to. The index ID is
596
+ # returned by the [ CreateIndex ][1] operation.
597
+ #
598
+ #
599
+ #
600
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html
601
+ # @return [String]
602
+ #
603
+ # @!attribute [rw] document_info_list
604
+ # A list of `DocumentInfo` objects that identify the documents for
605
+ # which to get the status. You identify the documents by their
606
+ # document ID and optional attributes.
607
+ # @return [Array<Types::DocumentInfo>]
608
+ #
609
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatusRequest AWS API Documentation
610
+ #
611
+ class BatchGetDocumentStatusRequest < Struct.new(
612
+ :index_id,
613
+ :document_info_list)
614
+ SENSITIVE = []
615
+ include Aws::Structure
616
+ end
617
+
618
+ # @!attribute [rw] errors
619
+ # A list of documents that Amazon Kendra couldn't get the status for.
620
+ # The list includes the ID of the document and the reason that the
621
+ # status couldn't be found.
622
+ # @return [Array<Types::BatchGetDocumentStatusResponseError>]
623
+ #
624
+ # @!attribute [rw] document_status_list
625
+ # The status of documents. The status indicates if the document is
626
+ # waiting to be indexed, is in the process of indexing, has completed
627
+ # indexing, or failed indexing. If a document failed indexing, the
628
+ # status provides the reason why.
629
+ # @return [Array<Types::Status>]
630
+ #
631
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatusResponse AWS API Documentation
632
+ #
633
+ class BatchGetDocumentStatusResponse < Struct.new(
634
+ :errors,
635
+ :document_status_list)
636
+ SENSITIVE = []
637
+ include Aws::Structure
638
+ end
639
+
640
+ # Provides a response when the status of a document could not be
641
+ # retrieved.
642
+ #
643
+ # @!attribute [rw] document_id
644
+ # The unique identifier of the document whose status could not be
645
+ # retrieved.
646
+ # @return [String]
647
+ #
648
+ # @!attribute [rw] error_code
649
+ # Indicates the source of the error.
650
+ # @return [String]
651
+ #
652
+ # @!attribute [rw] error_message
653
+ # States that the API could not get the status of a document. This
654
+ # could be because the request is not valid or there is a system
655
+ # error.
656
+ # @return [String]
657
+ #
658
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatusResponseError AWS API Documentation
659
+ #
660
+ class BatchGetDocumentStatusResponseError < Struct.new(
661
+ :document_id,
662
+ :error_code,
663
+ :error_message)
664
+ SENSITIVE = []
665
+ include Aws::Structure
666
+ end
667
+
571
668
  # @note When making an API call, you may pass BatchPutDocumentRequest
572
669
  # data as a hash:
573
670
  #
@@ -608,7 +705,7 @@ module Aws::Kendra
608
705
  #
609
706
  # @!attribute [rw] index_id
610
707
  # The identifier of the index to add the documents to. You need to
611
- # create the index first using the CreateIndex operation.
708
+ # create the index first using the `CreateIndex` operation.
612
709
  # @return [String]
613
710
  #
614
711
  # @!attribute [rw] role_arn
@@ -624,6 +721,13 @@ module Aws::Kendra
624
721
  # @!attribute [rw] documents
625
722
  # One or more documents to add to the index.
626
723
  #
724
+ # Documents can include custom attributes. For example,
725
+ # 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes
726
+ # that provide information on the synchronization of documents running
727
+ # on a data source. Note, 'DataSourceSyncJobId' could be an optional
728
+ # custom attribute as Amazon Kendra will use the ID of a running sync
729
+ # job.
730
+ #
627
731
  # Documents have the following file size limits.
628
732
  #
629
733
  # * 5 MB total size for inline documents
@@ -728,8 +832,28 @@ module Aws::Kendra
728
832
  include Aws::Structure
729
833
  end
730
834
 
835
+ # @note When making an API call, you may pass ClearQuerySuggestionsRequest
836
+ # data as a hash:
837
+ #
838
+ # {
839
+ # index_id: "IndexId", # required
840
+ # }
841
+ #
842
+ # @!attribute [rw] index_id
843
+ # The identifier of the index you want to clear query suggestions
844
+ # from.
845
+ # @return [String]
846
+ #
847
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ClearQuerySuggestionsRequest AWS API Documentation
848
+ #
849
+ class ClearQuerySuggestionsRequest < Struct.new(
850
+ :index_id)
851
+ SENSITIVE = []
852
+ include Aws::Structure
853
+ end
854
+
731
855
  # Gathers information about when a particular result was clicked by a
732
- # user. Your application uses the SubmitFeedback operation to provide
856
+ # user. Your application uses the `SubmitFeedback` operation to provide
733
857
  # click information.
734
858
  #
735
859
  # @note When making an API call, you may pass ClickFeedback
@@ -792,7 +916,7 @@ module Aws::Kendra
792
916
  # @!attribute [rw] field_mappings
793
917
  # An array of objects that map database column names to the
794
918
  # corresponding fields in an index. You must first create the fields
795
- # in the index using the UpdateIndex operation.
919
+ # in the index using the `UpdateIndex` operation.
796
920
  # @return [Array<Types::DataSourceToIndexFieldMapping>]
797
921
  #
798
922
  # @!attribute [rw] change_detecting_columns
@@ -868,7 +992,8 @@ module Aws::Kendra
868
992
  # Defines the mapping between a field in the Confluence data source to a
869
993
  # Amazon Kendra index field.
870
994
  #
871
- # You must first create the index field using the operation.
995
+ # You must first create the index field using the `UpdateIndex`
996
+ # operation.
872
997
  #
873
998
  # @note When making an API call, you may pass ConfluenceAttachmentToIndexFieldMapping
874
999
  # data as a hash:
@@ -882,7 +1007,8 @@ module Aws::Kendra
882
1007
  # @!attribute [rw] data_source_field_name
883
1008
  # The name of the field in the data source.
884
1009
  #
885
- # You must first create the index field using the operation.
1010
+ # You must first create the index field using the `UpdateIndex`
1011
+ # operation.
886
1012
  # @return [String]
887
1013
  #
888
1014
  # @!attribute [rw] date_field_format
@@ -909,7 +1035,8 @@ module Aws::Kendra
909
1035
 
910
1036
  # Specifies the blog settings for the Confluence data source. Blogs are
911
1037
  # always indexed unless filtered from the index by the
912
- # `ExclusionPatterns` or `InclusionPatterns` fields in the data type.
1038
+ # `ExclusionPatterns` or `InclusionPatterns` fields in the
1039
+ # `ConfluenceConfiguration` type.
913
1040
  #
914
1041
  # @note When making an API call, you may pass ConfluenceBlogConfiguration
915
1042
  # data as a hash:
@@ -945,7 +1072,8 @@ module Aws::Kendra
945
1072
  # Defines the mapping between a blog field in the Confluence data source
946
1073
  # to a Amazon Kendra index field.
947
1074
  #
948
- # You must first create the index field using the operation.
1075
+ # You must first create the index field using the `UpdateIndex`
1076
+ # operation.
949
1077
  #
950
1078
  # @note When making an API call, you may pass ConfluenceBlogToIndexFieldMapping
951
1079
  # data as a hash:
@@ -1158,7 +1286,8 @@ module Aws::Kendra
1158
1286
  # Defines the mapping between a field in the Confluence data source to a
1159
1287
  # Amazon Kendra index field.
1160
1288
  #
1161
- # You must first create the index field using the operation.
1289
+ # You must first create the index field using the `UpdateIndex`
1290
+ # operation.
1162
1291
  #
1163
1292
  # @note When making an API call, you may pass ConfluencePageToIndexFieldMapping
1164
1293
  # data as a hash:
@@ -1271,7 +1400,8 @@ module Aws::Kendra
1271
1400
  # Defines the mapping between a field in the Confluence data source to a
1272
1401
  # Amazon Kendra index field.
1273
1402
  #
1274
- # You must first create the index field using the operation.
1403
+ # You must first create the index field using the `UpdateIndex`
1404
+ # operation.
1275
1405
  #
1276
1406
  # @note When making an API call, you may pass ConfluenceSpaceToIndexFieldMapping
1277
1407
  # data as a hash:
@@ -1547,6 +1677,7 @@ module Aws::Kendra
1547
1677
  # index_field_name: "IndexFieldName", # required
1548
1678
  # },
1549
1679
  # ],
1680
+ # filter_query: "ServiceNowKnowledgeArticleFilterQuery",
1550
1681
  # },
1551
1682
  # service_catalog_configuration: {
1552
1683
  # crawl_attachments: false,
@@ -1562,6 +1693,7 @@ module Aws::Kendra
1562
1693
  # },
1563
1694
  # ],
1564
1695
  # },
1696
+ # authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
1565
1697
  # },
1566
1698
  # confluence_configuration: {
1567
1699
  # server_url: "Url", # required
@@ -1983,6 +2115,110 @@ module Aws::Kendra
1983
2115
  include Aws::Structure
1984
2116
  end
1985
2117
 
2118
+ # @note When making an API call, you may pass CreateQuerySuggestionsBlockListRequest
2119
+ # data as a hash:
2120
+ #
2121
+ # {
2122
+ # index_id: "IndexId", # required
2123
+ # name: "QuerySuggestionsBlockListName", # required
2124
+ # description: "Description",
2125
+ # source_s3_path: { # required
2126
+ # bucket: "S3BucketName", # required
2127
+ # key: "S3ObjectKey", # required
2128
+ # },
2129
+ # client_token: "ClientTokenName",
2130
+ # role_arn: "RoleArn", # required
2131
+ # tags: [
2132
+ # {
2133
+ # key: "TagKey", # required
2134
+ # value: "TagValue", # required
2135
+ # },
2136
+ # ],
2137
+ # }
2138
+ #
2139
+ # @!attribute [rw] index_id
2140
+ # The identifier of the index you want to create a query suggestions
2141
+ # block list for.
2142
+ # @return [String]
2143
+ #
2144
+ # @!attribute [rw] name
2145
+ # A user friendly name for the block list.
2146
+ #
2147
+ # For example, the block list named 'offensive-words' includes all
2148
+ # offensive words that could appear in user queries and need to be
2149
+ # blocked from suggestions.
2150
+ # @return [String]
2151
+ #
2152
+ # @!attribute [rw] description
2153
+ # A user-friendly description for the block list.
2154
+ #
2155
+ # For example, the description "List of all offensive words that can
2156
+ # appear in user queries and need to be blocked from suggestions."
2157
+ # @return [String]
2158
+ #
2159
+ # @!attribute [rw] source_s3_path
2160
+ # The S3 path to your block list text file in your S3 bucket.
2161
+ #
2162
+ # Each block word or phrase should be on a separate line in a text
2163
+ # file.
2164
+ #
2165
+ # For information on the current quota limits for block lists, see
2166
+ # [Quotas for Amazon Kendra][1].
2167
+ #
2168
+ #
2169
+ #
2170
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
2171
+ # @return [Types::S3Path]
2172
+ #
2173
+ # @!attribute [rw] client_token
2174
+ # A token that you provide to identify the request to create a query
2175
+ # suggestions block list.
2176
+ #
2177
+ # **A suitable default value is auto-generated.** You should normally
2178
+ # not need to pass this option.
2179
+ # @return [String]
2180
+ #
2181
+ # @!attribute [rw] role_arn
2182
+ # The IAM (Identity and Access Management) role used by Amazon Kendra
2183
+ # to access the block list text file in your S3 bucket.
2184
+ #
2185
+ # You need permissions to the role ARN (Amazon Resource Name). The
2186
+ # role needs S3 read permissions to your file in S3 and needs to give
2187
+ # STS (Security Token Service) assume role permissions to Amazon
2188
+ # Kendra.
2189
+ # @return [String]
2190
+ #
2191
+ # @!attribute [rw] tags
2192
+ # A tag that you can assign to a block list that categorizes the block
2193
+ # list.
2194
+ # @return [Array<Types::Tag>]
2195
+ #
2196
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockListRequest AWS API Documentation
2197
+ #
2198
+ class CreateQuerySuggestionsBlockListRequest < Struct.new(
2199
+ :index_id,
2200
+ :name,
2201
+ :description,
2202
+ :source_s3_path,
2203
+ :client_token,
2204
+ :role_arn,
2205
+ :tags)
2206
+ SENSITIVE = []
2207
+ include Aws::Structure
2208
+ end
2209
+
2210
+ # @!attribute [rw] id
2211
+ # The unique identifier of the created block list.
2212
+ # @return [String]
2213
+ #
2214
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockListResponse AWS API Documentation
2215
+ #
2216
+ class CreateQuerySuggestionsBlockListResponse < Struct.new(
2217
+ :id)
2218
+ SENSITIVE = []
2219
+ include Aws::Structure
2220
+ end
2221
+
1986
2222
  # @note When making an API call, you may pass CreateThesaurusRequest
1987
2223
  # data as a hash:
1988
2224
  #
@@ -2249,6 +2485,7 @@ module Aws::Kendra
2249
2485
  # index_field_name: "IndexFieldName", # required
2250
2486
  # },
2251
2487
  # ],
2488
+ # filter_query: "ServiceNowKnowledgeArticleFilterQuery",
2252
2489
  # },
2253
2490
  # service_catalog_configuration: {
2254
2491
  # crawl_attachments: false,
@@ -2264,6 +2501,7 @@ module Aws::Kendra
2264
2501
  # },
2265
2502
  # ],
2266
2503
  # },
2504
+ # authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
2267
2505
  # },
2268
2506
  # confluence_configuration: {
2269
2507
  # server_url: "Url", # required
@@ -2390,7 +2628,7 @@ module Aws::Kendra
2390
2628
  end
2391
2629
 
2392
2630
  # Summary information for a Amazon Kendra data source. Returned in a
2393
- # call to .
2631
+ # call to the `DescribeDataSource` operation.
2394
2632
  #
2395
2633
  # @!attribute [rw] name
2396
2634
  # The name of the data source.
@@ -2413,7 +2651,7 @@ module Aws::Kendra
2413
2651
  # @return [Time]
2414
2652
  #
2415
2653
  # @!attribute [rw] status
2416
- # The status of the data source. When the status is `ATIVE` the data
2654
+ # The status of the data source. When the status is `ACTIVE` the data
2417
2655
  # source is ready to use.
2418
2656
  # @return [String]
2419
2657
  #
@@ -2496,7 +2734,7 @@ module Aws::Kendra
2496
2734
  #
2497
2735
  # {
2498
2736
  # data_source_id: "DataSourceId", # required
2499
- # data_source_sync_job_id: "DataSourceSyncJobId", # required
2737
+ # data_source_sync_job_id: "DataSourceSyncJobId",
2500
2738
  # }
2501
2739
  #
2502
2740
  # @!attribute [rw] data_source_id
@@ -2505,6 +2743,15 @@ module Aws::Kendra
2505
2743
  #
2506
2744
  # @!attribute [rw] data_source_sync_job_id
2507
2745
  # The ID of the sync job that is running on the data source.
2746
+ #
2747
+ # If the ID of a sync job is not provided and there is a sync job
2748
+ # running, then the ID of this sync job is used and metrics are
2749
+ # generated for this sync job.
2750
+ #
2751
+ # If the ID of a sync job is not provided and there is no sync job
2752
+ # running, then no metrics are generated and documents are
2753
+ # indexed/deleted at the index level without sync job metrics
2754
+ # included.
2508
2755
  # @return [String]
2509
2756
  #
2510
2757
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSyncJobMetricTarget AWS API Documentation
@@ -2558,7 +2805,7 @@ module Aws::Kendra
2558
2805
  end
2559
2806
 
2560
2807
  # Maps a column or attribute in the data source to an index field. You
2561
- # must first create the fields in the index using the UpdateIndex
2808
+ # must first create the fields in the index using the `UpdateIndex`
2562
2809
  # operation.
2563
2810
  #
2564
2811
  # @note When making an API call, you may pass DataSourceToIndexFieldMapping
@@ -2771,6 +3018,31 @@ module Aws::Kendra
2771
3018
  include Aws::Structure
2772
3019
  end
2773
3020
 
3021
+ # @note When making an API call, you may pass DeleteQuerySuggestionsBlockListRequest
3022
+ # data as a hash:
3023
+ #
3024
+ # {
3025
+ # index_id: "IndexId", # required
3026
+ # id: "QuerySuggestionsBlockListId", # required
3027
+ # }
3028
+ #
3029
+ # @!attribute [rw] index_id
3030
+ # The identifier of the you want to delete a block list from.
3031
+ # @return [String]
3032
+ #
3033
+ # @!attribute [rw] id
3034
+ # The unique identifier of the block list that needs to be deleted.
3035
+ # @return [String]
3036
+ #
3037
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteQuerySuggestionsBlockListRequest AWS API Documentation
3038
+ #
3039
+ class DeleteQuerySuggestionsBlockListRequest < Struct.new(
3040
+ :index_id,
3041
+ :id)
3042
+ SENSITIVE = []
3043
+ include Aws::Structure
3044
+ end
3045
+
2774
3046
  # @note When making an API call, you may pass DeleteThesaurusRequest
2775
3047
  # data as a hash:
2776
3048
  #
@@ -3062,7 +3334,7 @@ module Aws::Kendra
3062
3334
  # @return [String]
3063
3335
  #
3064
3336
  # @!attribute [rw] capacity_units
3065
- # For enterprise edtion indexes, you can choose to use additional
3337
+ # For Enterprise edition indexes, you can choose to use additional
3066
3338
  # capacity to meet the needs of your application. This contains the
3067
3339
  # capacity units used for the index. A 0 for the query capacity or the
3068
3340
  # storage capacity indicates that the index is using the default
@@ -3099,132 +3371,344 @@ module Aws::Kendra
3099
3371
  include Aws::Structure
3100
3372
  end
3101
3373
 
3102
- # @note When making an API call, you may pass DescribeThesaurusRequest
3374
+ # @note When making an API call, you may pass DescribeQuerySuggestionsBlockListRequest
3103
3375
  # data as a hash:
3104
3376
  #
3105
3377
  # {
3106
- # id: "ThesaurusId", # required
3107
3378
  # index_id: "IndexId", # required
3379
+ # id: "QuerySuggestionsBlockListId", # required
3108
3380
  # }
3109
3381
  #
3110
- # @!attribute [rw] id
3111
- # The identifier of the thesaurus to describe.
3382
+ # @!attribute [rw] index_id
3383
+ # The identifier of the index for the block list.
3112
3384
  # @return [String]
3113
3385
  #
3114
- # @!attribute [rw] index_id
3115
- # The identifier of the index associated with the thesaurus to
3116
- # describe.
3386
+ # @!attribute [rw] id
3387
+ # The unique identifier of the block list.
3117
3388
  # @return [String]
3118
3389
  #
3119
- # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurusRequest AWS API Documentation
3390
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockListRequest AWS API Documentation
3120
3391
  #
3121
- class DescribeThesaurusRequest < Struct.new(
3122
- :id,
3123
- :index_id)
3392
+ class DescribeQuerySuggestionsBlockListRequest < Struct.new(
3393
+ :index_id,
3394
+ :id)
3124
3395
  SENSITIVE = []
3125
3396
  include Aws::Structure
3126
3397
  end
3127
3398
 
3128
- # @!attribute [rw] id
3129
- # The identifier of the thesaurus.
3399
+ # @!attribute [rw] index_id
3400
+ # Shows the identifier of the index for the block list.
3130
3401
  # @return [String]
3131
3402
  #
3132
- # @!attribute [rw] index_id
3133
- # The identifier of the index associated with the thesaurus to
3134
- # describe.
3403
+ # @!attribute [rw] id
3404
+ # Shows the unique identifier of the block list.
3135
3405
  # @return [String]
3136
3406
  #
3137
3407
  # @!attribute [rw] name
3138
- # The thesaurus name.
3408
+ # Shows the name of the block list.
3139
3409
  # @return [String]
3140
3410
  #
3141
3411
  # @!attribute [rw] description
3142
- # The thesaurus description.
3412
+ # Shows the description for the block list.
3143
3413
  # @return [String]
3144
3414
  #
3145
3415
  # @!attribute [rw] status
3146
- # The current status of the thesaurus. When the value is `ACTIVE`,
3147
- # queries are able to use the thesaurus. If the `Status` field value
3148
- # is `FAILED`, the `ErrorMessage` field provides more information.
3149
- #
3150
- # If the status is `ACTIVE_BUT_UPDATE_FAILED`, it means that Amazon
3151
- # Kendra could not ingest the new thesaurus file. The old thesaurus
3152
- # file is still active.
3416
+ # Shows whether the current status of the block list is `ACTIVE` or
3417
+ # `INACTIVE`.
3153
3418
  # @return [String]
3154
3419
  #
3155
3420
  # @!attribute [rw] error_message
3156
- # When the `Status` field value is `FAILED`, the `ErrorMessage` field
3157
- # provides more information.
3421
+ # Shows the error message with details when there are issues in
3422
+ # processing the block list.
3158
3423
  # @return [String]
3159
3424
  #
3160
3425
  # @!attribute [rw] created_at
3161
- # The Unix datetime that the thesaurus was created.
3426
+ # Shows the date-time a block list for query suggestions was last
3427
+ # created.
3162
3428
  # @return [Time]
3163
3429
  #
3164
3430
  # @!attribute [rw] updated_at
3165
- # The Unix datetime that the thesaurus was last updated.
3431
+ # Shows the date-time a block list for query suggestions was last
3432
+ # updated.
3166
3433
  # @return [Time]
3167
3434
  #
3168
- # @!attribute [rw] role_arn
3169
- # An AWS Identity and Access Management (IAM) role that gives Amazon
3170
- # Kendra permissions to access thesaurus file specified in
3171
- # `SourceS3Path`.
3172
- # @return [String]
3173
- #
3174
3435
  # @!attribute [rw] source_s3_path
3175
- # Information required to find a specific file in an Amazon S3 bucket.
3436
+ # Shows the current S3 path to your block list text file in your S3
3437
+ # bucket.
3438
+ #
3439
+ # Each block word or phrase should be on a separate line in a text
3440
+ # file.
3441
+ #
3442
+ # For information on the current quota limits for block lists, see
3443
+ # [Quotas for Amazon Kendra][1].
3444
+ #
3445
+ #
3446
+ #
3447
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
3176
3448
  # @return [Types::S3Path]
3177
3449
  #
3178
- # @!attribute [rw] file_size_bytes
3179
- # The size of the thesaurus file in bytes.
3450
+ # @!attribute [rw] item_count
3451
+ # Shows the current number of valid, non-empty words or phrases in the
3452
+ # block list text file.
3180
3453
  # @return [Integer]
3181
3454
  #
3182
- # @!attribute [rw] term_count
3183
- # The number of unique terms in the thesaurus file. For example, the
3184
- # synonyms `a,b,c` and `a=>d`, the term count would be 4.
3455
+ # @!attribute [rw] file_size_bytes
3456
+ # Shows the current size of the block list text file in S3.
3185
3457
  # @return [Integer]
3186
3458
  #
3187
- # @!attribute [rw] synonym_rule_count
3188
- # The number of synonym rules in the thesaurus file.
3189
- # @return [Integer]
3459
+ # @!attribute [rw] role_arn
3460
+ # Shows the current IAM (Identity and Access Management) role used by
3461
+ # Amazon Kendra to access the block list text file in S3.
3190
3462
  #
3191
- # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurusResponse AWS API Documentation
3463
+ # The role needs S3 read permissions to your file in S3 and needs to
3464
+ # give STS (Security Token Service) assume role permissions to Amazon
3465
+ # Kendra.
3466
+ # @return [String]
3192
3467
  #
3193
- class DescribeThesaurusResponse < Struct.new(
3194
- :id,
3468
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockListResponse AWS API Documentation
3469
+ #
3470
+ class DescribeQuerySuggestionsBlockListResponse < Struct.new(
3195
3471
  :index_id,
3472
+ :id,
3196
3473
  :name,
3197
3474
  :description,
3198
3475
  :status,
3199
3476
  :error_message,
3200
3477
  :created_at,
3201
3478
  :updated_at,
3202
- :role_arn,
3203
3479
  :source_s3_path,
3480
+ :item_count,
3204
3481
  :file_size_bytes,
3205
- :term_count,
3206
- :synonym_rule_count)
3482
+ :role_arn)
3207
3483
  SENSITIVE = []
3208
3484
  include Aws::Structure
3209
3485
  end
3210
3486
 
3211
- # A document in an index.
3212
- #
3213
- # @note When making an API call, you may pass Document
3487
+ # @note When making an API call, you may pass DescribeQuerySuggestionsConfigRequest
3214
3488
  # data as a hash:
3215
3489
  #
3216
3490
  # {
3217
- # id: "DocumentId", # required
3218
- # title: "Title",
3219
- # blob: "data",
3220
- # s3_path: {
3221
- # bucket: "S3BucketName", # required
3222
- # key: "S3ObjectKey", # required
3223
- # },
3224
- # attributes: [
3225
- # {
3226
- # key: "DocumentAttributeKey", # required
3227
- # value: { # required
3491
+ # index_id: "IndexId", # required
3492
+ # }
3493
+ #
3494
+ # @!attribute [rw] index_id
3495
+ # The identifier of the index you want to describe query suggestions
3496
+ # settings for.
3497
+ # @return [String]
3498
+ #
3499
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfigRequest AWS API Documentation
3500
+ #
3501
+ class DescribeQuerySuggestionsConfigRequest < Struct.new(
3502
+ :index_id)
3503
+ SENSITIVE = []
3504
+ include Aws::Structure
3505
+ end
3506
+
3507
+ # @!attribute [rw] mode
3508
+ # Shows whether query suggestions are currently in `ENABLED` mode or
3509
+ # `LEARN_ONLY` mode.
3510
+ #
3511
+ # By default, Amazon Kendra enables query suggestions.`LEARN_ONLY`
3512
+ # turns off query suggestions for your users. You can change the mode
3513
+ # using the [UpdateQuerySuggestionsConfig][1] operation.
3514
+ #
3515
+ #
3516
+ #
3517
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html
3518
+ # @return [String]
3519
+ #
3520
+ # @!attribute [rw] status
3521
+ # Shows whether the status of query suggestions settings is currently
3522
+ # Active or Updating.
3523
+ #
3524
+ # Active means the current settings apply and Updating means your
3525
+ # changed settings are in the process of applying.
3526
+ # @return [String]
3527
+ #
3528
+ # @!attribute [rw] query_log_look_back_window_in_days
3529
+ # Shows how recent your queries are in your query log time window (in
3530
+ # days).
3531
+ # @return [Integer]
3532
+ #
3533
+ # @!attribute [rw] include_queries_without_user_information
3534
+ # Shows whether Amazon Kendra uses all queries or only uses queries
3535
+ # that include user information to generate query suggestions.
3536
+ # @return [Boolean]
3537
+ #
3538
+ # @!attribute [rw] minimum_number_of_querying_users
3539
+ # Shows the minimum number of unique users who must search a query in
3540
+ # order for the query to be eligible to suggest to your users.
3541
+ # @return [Integer]
3542
+ #
3543
+ # @!attribute [rw] minimum_query_count
3544
+ # Shows the minimum number of times a query must be searched in order
3545
+ # for the query to be eligible to suggest to your users.
3546
+ # @return [Integer]
3547
+ #
3548
+ # @!attribute [rw] last_suggestions_build_time
3549
+ # Shows the date-time query suggestions for an index was last updated.
3550
+ # @return [Time]
3551
+ #
3552
+ # @!attribute [rw] last_clear_time
3553
+ # Shows the date-time query suggestions for an index was last cleared.
3554
+ #
3555
+ # After you clear suggestions, Amazon Kendra learns new suggestions
3556
+ # based on new queries added to the query log from the time you
3557
+ # cleared suggestions. Amazon Kendra only considers re-occurences of a
3558
+ # query from the time you cleared suggestions.
3559
+ # @return [Time]
3560
+ #
3561
+ # @!attribute [rw] total_suggestions_count
3562
+ # Shows the current total count of query suggestions for an index.
3563
+ #
3564
+ # This count can change when you update your query suggestions
3565
+ # settings, if you filter out certain queries from suggestions using a
3566
+ # block list, and as the query log accumulates more queries for Amazon
3567
+ # Kendra to learn from.
3568
+ # @return [Integer]
3569
+ #
3570
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfigResponse AWS API Documentation
3571
+ #
3572
+ class DescribeQuerySuggestionsConfigResponse < Struct.new(
3573
+ :mode,
3574
+ :status,
3575
+ :query_log_look_back_window_in_days,
3576
+ :include_queries_without_user_information,
3577
+ :minimum_number_of_querying_users,
3578
+ :minimum_query_count,
3579
+ :last_suggestions_build_time,
3580
+ :last_clear_time,
3581
+ :total_suggestions_count)
3582
+ SENSITIVE = []
3583
+ include Aws::Structure
3584
+ end
3585
+
3586
+ # @note When making an API call, you may pass DescribeThesaurusRequest
3587
+ # data as a hash:
3588
+ #
3589
+ # {
3590
+ # id: "ThesaurusId", # required
3591
+ # index_id: "IndexId", # required
3592
+ # }
3593
+ #
3594
+ # @!attribute [rw] id
3595
+ # The identifier of the thesaurus to describe.
3596
+ # @return [String]
3597
+ #
3598
+ # @!attribute [rw] index_id
3599
+ # The identifier of the index associated with the thesaurus to
3600
+ # describe.
3601
+ # @return [String]
3602
+ #
3603
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurusRequest AWS API Documentation
3604
+ #
3605
+ class DescribeThesaurusRequest < Struct.new(
3606
+ :id,
3607
+ :index_id)
3608
+ SENSITIVE = []
3609
+ include Aws::Structure
3610
+ end
3611
+
3612
+ # @!attribute [rw] id
3613
+ # The identifier of the thesaurus.
3614
+ # @return [String]
3615
+ #
3616
+ # @!attribute [rw] index_id
3617
+ # The identifier of the index associated with the thesaurus to
3618
+ # describe.
3619
+ # @return [String]
3620
+ #
3621
+ # @!attribute [rw] name
3622
+ # The thesaurus name.
3623
+ # @return [String]
3624
+ #
3625
+ # @!attribute [rw] description
3626
+ # The thesaurus description.
3627
+ # @return [String]
3628
+ #
3629
+ # @!attribute [rw] status
3630
+ # The current status of the thesaurus. When the value is `ACTIVE`,
3631
+ # queries are able to use the thesaurus. If the `Status` field value
3632
+ # is `FAILED`, the `ErrorMessage` field provides more information.
3633
+ #
3634
+ # If the status is `ACTIVE_BUT_UPDATE_FAILED`, it means that Amazon
3635
+ # Kendra could not ingest the new thesaurus file. The old thesaurus
3636
+ # file is still active.
3637
+ # @return [String]
3638
+ #
3639
+ # @!attribute [rw] error_message
3640
+ # When the `Status` field value is `FAILED`, the `ErrorMessage` field
3641
+ # provides more information.
3642
+ # @return [String]
3643
+ #
3644
+ # @!attribute [rw] created_at
3645
+ # The Unix datetime that the thesaurus was created.
3646
+ # @return [Time]
3647
+ #
3648
+ # @!attribute [rw] updated_at
3649
+ # The Unix datetime that the thesaurus was last updated.
3650
+ # @return [Time]
3651
+ #
3652
+ # @!attribute [rw] role_arn
3653
+ # An AWS Identity and Access Management (IAM) role that gives Amazon
3654
+ # Kendra permissions to access thesaurus file specified in
3655
+ # `SourceS3Path`.
3656
+ # @return [String]
3657
+ #
3658
+ # @!attribute [rw] source_s3_path
3659
+ # Information required to find a specific file in an Amazon S3 bucket.
3660
+ # @return [Types::S3Path]
3661
+ #
3662
+ # @!attribute [rw] file_size_bytes
3663
+ # The size of the thesaurus file in bytes.
3664
+ # @return [Integer]
3665
+ #
3666
+ # @!attribute [rw] term_count
3667
+ # The number of unique terms in the thesaurus file. For example, the
3668
+ # synonyms `a,b,c` and `a=>d`, the term count would be 4.
3669
+ # @return [Integer]
3670
+ #
3671
+ # @!attribute [rw] synonym_rule_count
3672
+ # The number of synonym rules in the thesaurus file.
3673
+ # @return [Integer]
3674
+ #
3675
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurusResponse AWS API Documentation
3676
+ #
3677
+ class DescribeThesaurusResponse < Struct.new(
3678
+ :id,
3679
+ :index_id,
3680
+ :name,
3681
+ :description,
3682
+ :status,
3683
+ :error_message,
3684
+ :created_at,
3685
+ :updated_at,
3686
+ :role_arn,
3687
+ :source_s3_path,
3688
+ :file_size_bytes,
3689
+ :term_count,
3690
+ :synonym_rule_count)
3691
+ SENSITIVE = []
3692
+ include Aws::Structure
3693
+ end
3694
+
3695
+ # A document in an index.
3696
+ #
3697
+ # @note When making an API call, you may pass Document
3698
+ # data as a hash:
3699
+ #
3700
+ # {
3701
+ # id: "DocumentId", # required
3702
+ # title: "Title",
3703
+ # blob: "data",
3704
+ # s3_path: {
3705
+ # bucket: "S3BucketName", # required
3706
+ # key: "S3ObjectKey", # required
3707
+ # },
3708
+ # attributes: [
3709
+ # {
3710
+ # key: "DocumentAttributeKey", # required
3711
+ # value: { # required
3228
3712
  # string_value: "DocumentAttributeStringValue",
3229
3713
  # string_list_value: ["String"],
3230
3714
  # long_value: 1,
@@ -3352,6 +3836,11 @@ module Aws::Kendra
3352
3836
  #
3353
3837
  # @!attribute [rw] date_value
3354
3838
  # A date expressed as an ISO 8601 string.
3839
+ #
3840
+ # It is important for the time zone to be included in the ISO 8601
3841
+ # date-time format. For example, 20120325T123010+01:00 is the ISO 8601
3842
+ # date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in
3843
+ # Central European Time.
3355
3844
  # @return [Time]
3356
3845
  #
3357
3846
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentAttributeValue AWS API Documentation
@@ -3386,6 +3875,61 @@ module Aws::Kendra
3386
3875
  include Aws::Structure
3387
3876
  end
3388
3877
 
3878
+ # Identifies a document for which to retrieve status information
3879
+ #
3880
+ # @note When making an API call, you may pass DocumentInfo
3881
+ # data as a hash:
3882
+ #
3883
+ # {
3884
+ # document_id: "DocumentId", # required
3885
+ # attributes: [
3886
+ # {
3887
+ # key: "DocumentAttributeKey", # required
3888
+ # value: { # required
3889
+ # string_value: "DocumentAttributeStringValue",
3890
+ # string_list_value: ["String"],
3891
+ # long_value: 1,
3892
+ # date_value: Time.now,
3893
+ # },
3894
+ # },
3895
+ # ],
3896
+ # }
3897
+ #
3898
+ # @!attribute [rw] document_id
3899
+ # The unique identifier of the document.
3900
+ # @return [String]
3901
+ #
3902
+ # @!attribute [rw] attributes
3903
+ # Attributes that identify a specific version of a document to check.
3904
+ #
3905
+ # The only valid attributes are:
3906
+ #
3907
+ # * version
3908
+ #
3909
+ # * datasourceId
3910
+ #
3911
+ # * jobExecutionId
3912
+ #
3913
+ # The attributes follow these rules:
3914
+ #
3915
+ # * `dataSourceId` and `jobExecutionId` must be used together.
3916
+ #
3917
+ # * `version` is ignored if `dataSourceId` and `jobExecutionId` are
3918
+ # not provided.
3919
+ #
3920
+ # * If `dataSourceId` and `jobExecutionId` are provided, but `version`
3921
+ # is not, the version defaults to "0".
3922
+ # @return [Array<Types::DocumentAttribute>]
3923
+ #
3924
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentInfo AWS API Documentation
3925
+ #
3926
+ class DocumentInfo < Struct.new(
3927
+ :document_id,
3928
+ :attributes)
3929
+ SENSITIVE = []
3930
+ include Aws::Structure
3931
+ end
3932
+
3389
3933
  # Specifies the properties of a custom index field.
3390
3934
  #
3391
3935
  # @note When making an API call, you may pass DocumentMetadataConfiguration
@@ -3439,6 +3983,45 @@ module Aws::Kendra
3439
3983
  include Aws::Structure
3440
3984
  end
3441
3985
 
3986
+ # Overrides the document relevance properties of a custom index field.
3987
+ #
3988
+ # @note When making an API call, you may pass DocumentRelevanceConfiguration
3989
+ # data as a hash:
3990
+ #
3991
+ # {
3992
+ # name: "DocumentMetadataConfigurationName", # required
3993
+ # relevance: { # required
3994
+ # freshness: false,
3995
+ # importance: 1,
3996
+ # duration: "Duration",
3997
+ # rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
3998
+ # value_importance_map: {
3999
+ # "ValueImportanceMapKey" => 1,
4000
+ # },
4001
+ # },
4002
+ # }
4003
+ #
4004
+ # @!attribute [rw] name
4005
+ # The name of the tuning configuration to override document relevance
4006
+ # at the index level.
4007
+ # @return [String]
4008
+ #
4009
+ # @!attribute [rw] relevance
4010
+ # Provides information for manually tuning the relevance of a field in
4011
+ # a search. When a query includes terms that match the field, the
4012
+ # results are given a boost in the response based on these tuning
4013
+ # parameters.
4014
+ # @return [Types::Relevance]
4015
+ #
4016
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentRelevanceConfiguration AWS API Documentation
4017
+ #
4018
+ class DocumentRelevanceConfiguration < Struct.new(
4019
+ :name,
4020
+ :relevance)
4021
+ SENSITIVE = []
4022
+ include Aws::Structure
4023
+ end
4024
+
3442
4025
  # Document metadata files that contain information such as the document
3443
4026
  # access control information, source URI, document author, and custom
3444
4027
  # attributes. Each metadata file contains metadata about a single
@@ -3572,6 +4155,63 @@ module Aws::Kendra
3572
4155
  include Aws::Structure
3573
4156
  end
3574
4157
 
4158
+ # @note When making an API call, you may pass GetQuerySuggestionsRequest
4159
+ # data as a hash:
4160
+ #
4161
+ # {
4162
+ # index_id: "IndexId", # required
4163
+ # query_text: "SuggestionQueryText", # required
4164
+ # max_suggestions_count: 1,
4165
+ # }
4166
+ #
4167
+ # @!attribute [rw] index_id
4168
+ # The identifier of the index you want to get query suggestions from.
4169
+ # @return [String]
4170
+ #
4171
+ # @!attribute [rw] query_text
4172
+ # The text of a user's query to generate query suggestions.
4173
+ #
4174
+ # A query is suggested if the query prefix matches what a user starts
4175
+ # to type as their query.
4176
+ #
4177
+ # Amazon Kendra does not show any suggestions if a user types fewer
4178
+ # than two characters or more than 60 characters. A query must also
4179
+ # have at least one search result and contain at least one word of
4180
+ # more than four characters.
4181
+ # @return [String]
4182
+ #
4183
+ # @!attribute [rw] max_suggestions_count
4184
+ # The maximum number of query suggestions you want to show to your
4185
+ # users.
4186
+ # @return [Integer]
4187
+ #
4188
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestionsRequest AWS API Documentation
4189
+ #
4190
+ class GetQuerySuggestionsRequest < Struct.new(
4191
+ :index_id,
4192
+ :query_text,
4193
+ :max_suggestions_count)
4194
+ SENSITIVE = []
4195
+ include Aws::Structure
4196
+ end
4197
+
4198
+ # @!attribute [rw] query_suggestions_id
4199
+ # The unique identifier for a list of query suggestions for an index.
4200
+ # @return [String]
4201
+ #
4202
+ # @!attribute [rw] suggestions
4203
+ # A list of query suggestions for an index.
4204
+ # @return [Array<Types::Suggestion>]
4205
+ #
4206
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestionsResponse AWS API Documentation
4207
+ #
4208
+ class GetQuerySuggestionsResponse < Struct.new(
4209
+ :query_suggestions_id,
4210
+ :suggestions)
4211
+ SENSITIVE = []
4212
+ include Aws::Structure
4213
+ end
4214
+
3575
4215
  # Provides configuration information for data sources that connect to
3576
4216
  # Google Drive.
3577
4217
  #
@@ -3629,7 +4269,7 @@ module Aws::Kendra
3629
4269
  #
3630
4270
  # If you are using the console, you can define index fields when
3631
4271
  # creating the mapping. If you are using the API, you must first
3632
- # create the field using the UpdateIndex operation.
4272
+ # create the field using the `UpdateIndex` operation.
3633
4273
  # @return [Array<Types::DataSourceToIndexFieldMapping>]
3634
4274
  #
3635
4275
  # @!attribute [rw] exclude_mime_types
@@ -4052,45 +4692,117 @@ module Aws::Kendra
4052
4692
  # @note When making an API call, you may pass ListIndicesRequest
4053
4693
  # data as a hash:
4054
4694
  #
4055
- # {
4056
- # next_token: "NextToken",
4057
- # max_results: 1,
4058
- # }
4695
+ # {
4696
+ # next_token: "NextToken",
4697
+ # max_results: 1,
4698
+ # }
4699
+ #
4700
+ # @!attribute [rw] next_token
4701
+ # If the previous response was incomplete (because there is more data
4702
+ # to retrieve), Amazon Kendra returns a pagination token in the
4703
+ # response. You can use this pagination token to retrieve the next set
4704
+ # of indexes (`DataSourceSummaryItems`).
4705
+ # @return [String]
4706
+ #
4707
+ # @!attribute [rw] max_results
4708
+ # The maximum number of data sources to return.
4709
+ # @return [Integer]
4710
+ #
4711
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndicesRequest AWS API Documentation
4712
+ #
4713
+ class ListIndicesRequest < Struct.new(
4714
+ :next_token,
4715
+ :max_results)
4716
+ SENSITIVE = []
4717
+ include Aws::Structure
4718
+ end
4719
+
4720
+ # @!attribute [rw] index_configuration_summary_items
4721
+ # An array of summary information for one or more indexes.
4722
+ # @return [Array<Types::IndexConfigurationSummary>]
4723
+ #
4724
+ # @!attribute [rw] next_token
4725
+ # If the response is truncated, Amazon Kendra returns this token that
4726
+ # you can use in the subsequent request to retrieve the next set of
4727
+ # indexes.
4728
+ # @return [String]
4729
+ #
4730
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndicesResponse AWS API Documentation
4731
+ #
4732
+ class ListIndicesResponse < Struct.new(
4733
+ :index_configuration_summary_items,
4734
+ :next_token)
4735
+ SENSITIVE = []
4736
+ include Aws::Structure
4737
+ end
4738
+
4739
+ # @note When making an API call, you may pass ListQuerySuggestionsBlockListsRequest
4740
+ # data as a hash:
4741
+ #
4742
+ # {
4743
+ # index_id: "IndexId", # required
4744
+ # next_token: "NextToken",
4745
+ # max_results: 1,
4746
+ # }
4747
+ #
4748
+ # @!attribute [rw] index_id
4749
+ # The identifier of the index for a list of all block lists that exist
4750
+ # for that index.
4751
+ #
4752
+ # For information on the current quota limits for block lists, see
4753
+ # [Quotas for Amazon Kendra][1].
4754
+ #
4755
+ #
4756
+ #
4757
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
4758
+ # @return [String]
4059
4759
  #
4060
4760
  # @!attribute [rw] next_token
4061
4761
  # If the previous response was incomplete (because there is more data
4062
4762
  # to retrieve), Amazon Kendra returns a pagination token in the
4063
4763
  # response. You can use this pagination token to retrieve the next set
4064
- # of indexes (`DataSourceSummaryItems`).
4764
+ # of block lists (`BlockListSummaryItems`).
4065
4765
  # @return [String]
4066
4766
  #
4067
4767
  # @!attribute [rw] max_results
4068
- # The maximum number of data sources to return.
4768
+ # The maximum number of block lists to return.
4069
4769
  # @return [Integer]
4070
4770
  #
4071
- # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndicesRequest AWS API Documentation
4771
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockListsRequest AWS API Documentation
4072
4772
  #
4073
- class ListIndicesRequest < Struct.new(
4773
+ class ListQuerySuggestionsBlockListsRequest < Struct.new(
4774
+ :index_id,
4074
4775
  :next_token,
4075
4776
  :max_results)
4076
4777
  SENSITIVE = []
4077
4778
  include Aws::Structure
4078
4779
  end
4079
4780
 
4080
- # @!attribute [rw] index_configuration_summary_items
4081
- # An array of summary information for one or more indexes.
4082
- # @return [Array<Types::IndexConfigurationSummary>]
4781
+ # @!attribute [rw] block_list_summary_items
4782
+ # Summary items for a block list.
4783
+ #
4784
+ # This includes summary items on the block list ID, block list name,
4785
+ # when the block list was created, when the block list was last
4786
+ # updated, and the count of block words/phrases in the block list.
4787
+ #
4788
+ # For information on the current quota limits for block lists, see
4789
+ # [Quotas for Amazon Kendra][1].
4790
+ #
4791
+ #
4792
+ #
4793
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
4794
+ # @return [Array<Types::QuerySuggestionsBlockListSummary>]
4083
4795
  #
4084
4796
  # @!attribute [rw] next_token
4085
4797
  # If the response is truncated, Amazon Kendra returns this token that
4086
4798
  # you can use in the subsequent request to retrieve the next set of
4087
- # indexes.
4799
+ # block lists.
4088
4800
  # @return [String]
4089
4801
  #
4090
- # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListIndicesResponse AWS API Documentation
4802
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListQuerySuggestionsBlockListsResponse AWS API Documentation
4091
4803
  #
4092
- class ListIndicesResponse < Struct.new(
4093
- :index_configuration_summary_items,
4804
+ class ListQuerySuggestionsBlockListsResponse < Struct.new(
4805
+ :block_list_summary_items,
4094
4806
  :next_token)
4095
4807
  SENSITIVE = []
4096
4808
  include Aws::Structure
@@ -4427,6 +5139,20 @@ module Aws::Kendra
4427
5139
  # ],
4428
5140
  # requested_document_attributes: ["DocumentAttributeKey"],
4429
5141
  # query_result_type_filter: "DOCUMENT", # accepts DOCUMENT, QUESTION_ANSWER, ANSWER
5142
+ # document_relevance_override_configurations: [
5143
+ # {
5144
+ # name: "DocumentMetadataConfigurationName", # required
5145
+ # relevance: { # required
5146
+ # freshness: false,
5147
+ # importance: 1,
5148
+ # duration: "Duration",
5149
+ # rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
5150
+ # value_importance_map: {
5151
+ # "ValueImportanceMapKey" => 1,
5152
+ # },
5153
+ # },
5154
+ # },
5155
+ # ],
4430
5156
  # page_number: 1,
4431
5157
  # page_size: 1,
4432
5158
  # sorting_configuration: {
@@ -4441,7 +5167,7 @@ module Aws::Kendra
4441
5167
  #
4442
5168
  # @!attribute [rw] index_id
4443
5169
  # The unique identifier of the index to search. The identifier is
4444
- # returned in the response from the operation.
5170
+ # returned in the response from the `CreateIndex` operation.
4445
5171
  # @return [String]
4446
5172
  #
4447
5173
  # @!attribute [rw] query_text
@@ -4476,6 +5202,25 @@ module Aws::Kendra
4476
5202
  # are returned.
4477
5203
  # @return [String]
4478
5204
  #
5205
+ # @!attribute [rw] document_relevance_override_configurations
5206
+ # Overrides relevance tuning configurations of fields or attributes
5207
+ # set at the index level.
5208
+ #
5209
+ # If you use this API to override the relevance tuning configured at
5210
+ # the index level, but there is no relevance tuning configured at the
5211
+ # index level, then Amazon Kendra does not apply any relevance tuning.
5212
+ #
5213
+ # If there is relevance tuning configured at the index level, but you
5214
+ # do not use this API to override any relevance tuning in the index,
5215
+ # then Amazon Kendra uses the relevance tuning that is configured at
5216
+ # the index level.
5217
+ #
5218
+ # If there is relevance tuning configured for fields at the index
5219
+ # level, but you use this API to override only some of these fields,
5220
+ # then for the fields you did not override, the importance is set to
5221
+ # 1.
5222
+ # @return [Array<Types::DocumentRelevanceConfiguration>]
5223
+ #
4479
5224
  # @!attribute [rw] page_number
4480
5225
  # Query results are returned in pages the size of the `PageSize`
4481
5226
  # parameter. By default, Amazon Kendra returns the first page of
@@ -4520,6 +5265,7 @@ module Aws::Kendra
4520
5265
  :facets,
4521
5266
  :requested_document_attributes,
4522
5267
  :query_result_type_filter,
5268
+ :document_relevance_override_configurations,
4523
5269
  :page_number,
4524
5270
  :page_size,
4525
5271
  :sorting_configuration,
@@ -4643,6 +5389,57 @@ module Aws::Kendra
4643
5389
  include Aws::Structure
4644
5390
  end
4645
5391
 
5392
+ # Summary information on a query suggestions block list.
5393
+ #
5394
+ # This includes information on the block list ID, block list name, when
5395
+ # the block list was created, when the block list was last updated, and
5396
+ # the count of block words/phrases in the block list.
5397
+ #
5398
+ # For information on the current quota limits for block lists, see
5399
+ # [Quotas for Amazon Kendra][1].
5400
+ #
5401
+ #
5402
+ #
5403
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
5404
+ #
5405
+ # @!attribute [rw] id
5406
+ # The identifier of a block list.
5407
+ # @return [String]
5408
+ #
5409
+ # @!attribute [rw] name
5410
+ # The name of the block list.
5411
+ # @return [String]
5412
+ #
5413
+ # @!attribute [rw] status
5414
+ # The status of the block list.
5415
+ # @return [String]
5416
+ #
5417
+ # @!attribute [rw] created_at
5418
+ # The date-time summary information for a query suggestions block list
5419
+ # was last created.
5420
+ # @return [Time]
5421
+ #
5422
+ # @!attribute [rw] updated_at
5423
+ # The date-time the block list was last updated.
5424
+ # @return [Time]
5425
+ #
5426
+ # @!attribute [rw] item_count
5427
+ # The number of items in the block list file.
5428
+ # @return [Integer]
5429
+ #
5430
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QuerySuggestionsBlockListSummary AWS API Documentation
5431
+ #
5432
+ class QuerySuggestionsBlockListSummary < Struct.new(
5433
+ :id,
5434
+ :name,
5435
+ :status,
5436
+ :created_at,
5437
+ :updated_at,
5438
+ :item_count)
5439
+ SENSITIVE = []
5440
+ include Aws::Structure
5441
+ end
5442
+
4646
5443
  # Provides information for manually tuning the relevance of a field in a
4647
5444
  # search. When a query includes terms that match the field, the results
4648
5445
  # are given a boost in the response based on these tuning parameters.
@@ -4727,7 +5524,7 @@ module Aws::Kendra
4727
5524
  end
4728
5525
 
4729
5526
  # Provides feedback on how relevant a document is to a search. Your
4730
- # application uses the SubmitFeedback operation to provide relevance
5527
+ # application uses the `SubmitFeedback` operation to provide relevance
4731
5528
  # information.
4732
5529
  #
4733
5530
  # @note When making an API call, you may pass RelevanceFeedback
@@ -4833,12 +5630,21 @@ module Aws::Kendra
4833
5630
  # document that matches an inclusion pattern also matches an exclusion
4834
5631
  # pattern, the document is not indexed.
4835
5632
  #
4836
- # For more information about glob patterns, see [glob
4837
- # (programming)][1] in *Wikipedia*.
5633
+ # Some [examples][1] are:
5634
+ #
5635
+ # * **.txt* will include all text files in a directory (files with
5636
+ # the extension .txt).
5637
+ #
5638
+ # * ***/*.txt* will include all text files in a directory and its
5639
+ # subdirectories.
5640
+ #
5641
+ # * **tax** will include all files in a directory that contain
5642
+ # 'tax' in the file name, such as 'tax', 'taxes',
5643
+ # 'income\_tax'.
4838
5644
  #
4839
5645
  #
4840
5646
  #
4841
- # [1]: https://en.wikipedia.org/wiki/Glob_(programming)
5647
+ # [1]: https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters
4842
5648
  # @return [Array<String>]
4843
5649
  #
4844
5650
  # @!attribute [rw] exclusion_patterns
@@ -4846,12 +5652,21 @@ module Aws::Kendra
4846
5652
  # a document that matches an inclusion prefix or inclusion pattern
4847
5653
  # also matches an exclusion pattern, the document is not indexed.
4848
5654
  #
4849
- # For more information about glob patterns, see [glob
4850
- # (programming)][1] in *Wikipedia*.
5655
+ # Some [examples][1] are:
4851
5656
  #
5657
+ # * **.png , *.jpg* will exclude all PNG and JPEG image files in a
5658
+ # directory (files with the extensions .png and .jpg).
4852
5659
  #
5660
+ # * **internal** will exclude all files in a directory that contain
5661
+ # 'internal' in the file name, such as 'internal',
5662
+ # 'internal\_only', 'company\_internal'.
4853
5663
  #
4854
- # [1]: https://en.wikipedia.org/wiki/Glob_(programming)
5664
+ # * ***/*internal** will exclude all internal-related files in a
5665
+ # directory and its subdirectories.
5666
+ #
5667
+ #
5668
+ #
5669
+ # [1]: https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters
4855
5670
  # @return [Array<String>]
4856
5671
  #
4857
5672
  # @!attribute [rw] documents_metadata_configuration
@@ -4938,7 +5753,7 @@ module Aws::Kendra
4938
5753
  # @!attribute [rw] document_title_field_name
4939
5754
  # The name of the column in the Salesforce FeedItem table that
4940
5755
  # contains the title of the document. This is typically the `Title`
4941
- # collumn.
5756
+ # column.
4942
5757
  # @return [String]
4943
5758
  #
4944
5759
  # @!attribute [rw] field_mappings
@@ -5078,7 +5893,7 @@ module Aws::Kendra
5078
5893
  # @return [Array<Types::SalesforceStandardObjectConfiguration>]
5079
5894
  #
5080
5895
  # @!attribute [rw] knowledge_article_configuration
5081
- # Specifies configuration information for the knowlege article types
5896
+ # Specifies configuration information for the knowledge article types
5082
5897
  # that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
5083
5898
  # articles and the standard fields of knowledge articles, or the
5084
5899
  # custom fields of custom knowledge articles, but not both.
@@ -5183,7 +5998,7 @@ module Aws::Kendra
5183
5998
  include Aws::Structure
5184
5999
  end
5185
6000
 
5186
- # Specifies configuration information for the knowlege article types
6001
+ # Specifies configuration information for the knowledge article types
5187
6002
  # that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
5188
6003
  # articles and the standard fields of knowledge articles, or the custom
5189
6004
  # fields of custom knowledge articles, but not both
@@ -5323,7 +6138,7 @@ module Aws::Kendra
5323
6138
  include Aws::Structure
5324
6139
  end
5325
6140
 
5326
- # Specifies confguration information for indexing a single standard
6141
+ # Specifies configuration information for indexing a single standard
5327
6142
  # object.
5328
6143
  #
5329
6144
  # @note When making an API call, you may pass SalesforceStandardObjectConfiguration
@@ -5353,7 +6168,7 @@ module Aws::Kendra
5353
6168
  #
5354
6169
  # @!attribute [rw] document_title_field_name
5355
6170
  # The name of the field in the standard object table that contains the
5356
- # document titleB.
6171
+ # document title.
5357
6172
  # @return [String]
5358
6173
  #
5359
6174
  # @!attribute [rw] field_mappings
@@ -5485,6 +6300,7 @@ module Aws::Kendra
5485
6300
  # index_field_name: "IndexFieldName", # required
5486
6301
  # },
5487
6302
  # ],
6303
+ # filter_query: "ServiceNowKnowledgeArticleFilterQuery",
5488
6304
  # },
5489
6305
  # service_catalog_configuration: {
5490
6306
  # crawl_attachments: false,
@@ -5500,6 +6316,7 @@ module Aws::Kendra
5500
6316
  # },
5501
6317
  # ],
5502
6318
  # },
6319
+ # authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
5503
6320
  # }
5504
6321
  #
5505
6322
  # @!attribute [rw] host_url
@@ -5529,6 +6346,25 @@ module Aws::Kendra
5529
6346
  # the ServiceNow site.
5530
6347
  # @return [Types::ServiceNowServiceCatalogConfiguration]
5531
6348
  #
6349
+ # @!attribute [rw] authentication_type
6350
+ # Determines the type of authentication used to connect to the
6351
+ # ServiceNow instance. If you choose `HTTP_BASIC`, Amazon Kendra is
6352
+ # authenticated using the user name and password provided in the AWS
6353
+ # Secrets Manager secret in the `SecretArn` field. When you choose
6354
+ # `OAUTH2`, Amazon Kendra is authenticated using the OAuth token and
6355
+ # secret provided in the Secrets Manager secret, and the user name and
6356
+ # password are used to determine which information Amazon Kendra has
6357
+ # access to.
6358
+ #
6359
+ # When you use `OAUTH2` authentication, you must generate a token and
6360
+ # a client secret using the ServiceNow console. For more information,
6361
+ # see [Using a ServiceNow data source][1].
6362
+ #
6363
+ #
6364
+ #
6365
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html
6366
+ # @return [String]
6367
+ #
5532
6368
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowConfiguration AWS API Documentation
5533
6369
  #
5534
6370
  class ServiceNowConfiguration < Struct.new(
@@ -5536,7 +6372,8 @@ module Aws::Kendra
5536
6372
  :secret_arn,
5537
6373
  :service_now_build_version,
5538
6374
  :knowledge_article_configuration,
5539
- :service_catalog_configuration)
6375
+ :service_catalog_configuration,
6376
+ :authentication_type)
5540
6377
  SENSITIVE = []
5541
6378
  include Aws::Structure
5542
6379
  end
@@ -5560,6 +6397,7 @@ module Aws::Kendra
5560
6397
  # index_field_name: "IndexFieldName", # required
5561
6398
  # },
5562
6399
  # ],
6400
+ # filter_query: "ServiceNowKnowledgeArticleFilterQuery",
5563
6401
  # }
5564
6402
  #
5565
6403
  # @!attribute [rw] crawl_attachments
@@ -5594,6 +6432,20 @@ module Aws::Kendra
5594
6432
  # You must create the index field before you map the field.
5595
6433
  # @return [Array<Types::DataSourceToIndexFieldMapping>]
5596
6434
  #
6435
+ # @!attribute [rw] filter_query
6436
+ # A query that selects the knowledge articles to index. The query can
6437
+ # return articles from multiple knowledge bases, and the knowledge
6438
+ # bases can be public or private.
6439
+ #
6440
+ # The query string must be one generated by the ServiceNow console.
6441
+ # For more information, see [Specifying documents to index with a
6442
+ # query][1].
6443
+ #
6444
+ #
6445
+ #
6446
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/servicenow-query.html
6447
+ # @return [String]
6448
+ #
5597
6449
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowKnowledgeArticleConfiguration AWS API Documentation
5598
6450
  #
5599
6451
  class ServiceNowKnowledgeArticleConfiguration < Struct.new(
@@ -5602,7 +6454,8 @@ module Aws::Kendra
5602
6454
  :exclude_attachment_file_patterns,
5603
6455
  :document_data_field_name,
5604
6456
  :document_title_field_name,
5605
- :field_mappings)
6457
+ :field_mappings,
6458
+ :filter_query)
5606
6459
  SENSITIVE = []
5607
6460
  include Aws::Structure
5608
6461
  end
@@ -5634,13 +6487,23 @@ module Aws::Kendra
5634
6487
  # @return [Boolean]
5635
6488
  #
5636
6489
  # @!attribute [rw] include_attachment_file_patterns
5637
- # Determines the types of file attachments that are included in the
5638
- # index.
6490
+ # A list of regular expression patterns. Documents that match the
6491
+ # patterns are included in the index. Documents that don't match the
6492
+ # patterns are excluded from the index. If a document matches both an
6493
+ # exclusion pattern and an inclusion pattern, the document is not
6494
+ # included in the index.
6495
+ #
6496
+ # The regex is applied to the file name of the attachment.
5639
6497
  # @return [Array<String>]
5640
6498
  #
5641
6499
  # @!attribute [rw] exclude_attachment_file_patterns
5642
- # Determines the types of file attachments that are excluded from the
5643
- # index.
6500
+ # A list of regular expression patterns. Documents that match the
6501
+ # patterns are excluded from the index. Documents that don't match
6502
+ # the patterns are included in the index. If a document matches both
6503
+ # an exclusion pattern and an inclusion pattern, the document is not
6504
+ # included in the index.
6505
+ #
6506
+ # The regex is applied to the file name of the attachment.
5644
6507
  # @return [Array<String>]
5645
6508
  #
5646
6509
  # @!attribute [rw] document_data_field_name
@@ -5775,9 +6638,9 @@ module Aws::Kendra
5775
6638
  # @!attribute [rw] field_mappings
5776
6639
  # A list of `DataSourceToIndexFieldMapping` objects that map Microsoft
5777
6640
  # SharePoint attributes to custom fields in the Amazon Kendra index.
5778
- # You must first create the index fields using the operation before
5779
- # you map SharePoint attributes. For more information, see [Mapping
5780
- # Data Source Fields][1].
6641
+ # You must first create the index fields using the `UpdateIndex`
6642
+ # operation before you map SharePoint attributes. For more
6643
+ # information, see [Mapping Data Source Fields][1].
5781
6644
  #
5782
6645
  #
5783
6646
  #
@@ -5943,6 +6806,41 @@ module Aws::Kendra
5943
6806
  include Aws::Structure
5944
6807
  end
5945
6808
 
6809
+ # Provides information about the status of documents submitted for
6810
+ # indexing.
6811
+ #
6812
+ # @!attribute [rw] document_id
6813
+ # The unique identifier of the document.
6814
+ # @return [String]
6815
+ #
6816
+ # @!attribute [rw] document_status
6817
+ # The current status of a document.
6818
+ #
6819
+ # If the document was submitted for deletion, the status is
6820
+ # `NOT_FOUND` after the document is deleted.
6821
+ # @return [String]
6822
+ #
6823
+ # @!attribute [rw] failure_code
6824
+ # Indicates the source of the error.
6825
+ # @return [String]
6826
+ #
6827
+ # @!attribute [rw] failure_reason
6828
+ # Provides detailed information about why the document couldn't be
6829
+ # indexed. Use this information to correct the error before you
6830
+ # resubmit the document for indexing.
6831
+ # @return [String]
6832
+ #
6833
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Status AWS API Documentation
6834
+ #
6835
+ class Status < Struct.new(
6836
+ :document_id,
6837
+ :document_status,
6838
+ :failure_code,
6839
+ :failure_reason)
6840
+ SENSITIVE = []
6841
+ include Aws::Structure
6842
+ end
6843
+
5946
6844
  # @note When making an API call, you may pass StopDataSourceSyncJobRequest
5947
6845
  # data as a hash:
5948
6846
  #
@@ -5995,7 +6893,8 @@ module Aws::Kendra
5995
6893
  #
5996
6894
  # @!attribute [rw] query_id
5997
6895
  # The identifier of the specific query for which you are submitting
5998
- # feedback. The query ID is returned in the response to the operation.
6896
+ # feedback. The query ID is returned in the response to the `Query`
6897
+ # operation.
5999
6898
  # @return [String]
6000
6899
  #
6001
6900
  # @!attribute [rw] click_feedback_items
@@ -6019,6 +6918,86 @@ module Aws::Kendra
6019
6918
  include Aws::Structure
6020
6919
  end
6021
6920
 
6921
+ # A single query suggestion.
6922
+ #
6923
+ # @!attribute [rw] id
6924
+ # The unique UUID (universally unique identifier) of a single query
6925
+ # suggestion.
6926
+ # @return [String]
6927
+ #
6928
+ # @!attribute [rw] value
6929
+ # The value for the unique UUID (universally unique identifier) of a
6930
+ # single query suggestion.
6931
+ #
6932
+ # The value is the text string of a suggestion.
6933
+ # @return [Types::SuggestionValue]
6934
+ #
6935
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Suggestion AWS API Documentation
6936
+ #
6937
+ class Suggestion < Struct.new(
6938
+ :id,
6939
+ :value)
6940
+ SENSITIVE = []
6941
+ include Aws::Structure
6942
+ end
6943
+
6944
+ # The text highlights for a single query suggestion.
6945
+ #
6946
+ # @!attribute [rw] begin_offset
6947
+ # The zero-based location in the response string where the highlight
6948
+ # starts.
6949
+ # @return [Integer]
6950
+ #
6951
+ # @!attribute [rw] end_offset
6952
+ # The zero-based location in the response string where the highlight
6953
+ # ends.
6954
+ # @return [Integer]
6955
+ #
6956
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SuggestionHighlight AWS API Documentation
6957
+ #
6958
+ class SuggestionHighlight < Struct.new(
6959
+ :begin_offset,
6960
+ :end_offset)
6961
+ SENSITIVE = []
6962
+ include Aws::Structure
6963
+ end
6964
+
6965
+ # Provides text and information about where to highlight the query
6966
+ # suggestion text.
6967
+ #
6968
+ # @!attribute [rw] text
6969
+ # The query suggestion text to display to the user.
6970
+ # @return [String]
6971
+ #
6972
+ # @!attribute [rw] highlights
6973
+ # The beginning and end of the query suggestion text that should be
6974
+ # highlighted.
6975
+ # @return [Array<Types::SuggestionHighlight>]
6976
+ #
6977
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SuggestionTextWithHighlights AWS API Documentation
6978
+ #
6979
+ class SuggestionTextWithHighlights < Struct.new(
6980
+ :text,
6981
+ :highlights)
6982
+ SENSITIVE = []
6983
+ include Aws::Structure
6984
+ end
6985
+
6986
+ # The `SuggestionTextWithHighlights` structure information.
6987
+ #
6988
+ # @!attribute [rw] text
6989
+ # The `SuggestionTextWithHighlights` structure that contains the query
6990
+ # suggestion text and highlights.
6991
+ # @return [Types::SuggestionTextWithHighlights]
6992
+ #
6993
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SuggestionValue AWS API Documentation
6994
+ #
6995
+ class SuggestionValue < Struct.new(
6996
+ :text)
6997
+ SENSITIVE = []
6998
+ include Aws::Structure
6999
+ end
7000
+
6022
7001
  # A list of key/value pairs that identify an index, FAQ, or data source.
6023
7002
  # Tag keys and values can consist of Unicode letters, digits, white
6024
7003
  # space, and any of the following symbols: \_ . : / = + - @.
@@ -6412,6 +7391,7 @@ module Aws::Kendra
6412
7391
  # index_field_name: "IndexFieldName", # required
6413
7392
  # },
6414
7393
  # ],
7394
+ # filter_query: "ServiceNowKnowledgeArticleFilterQuery",
6415
7395
  # },
6416
7396
  # service_catalog_configuration: {
6417
7397
  # crawl_attachments: false,
@@ -6427,6 +7407,7 @@ module Aws::Kendra
6427
7407
  # },
6428
7408
  # ],
6429
7409
  # },
7410
+ # authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
6430
7411
  # },
6431
7412
  # confluence_configuration: {
6432
7413
  # server_url: "Url", # required
@@ -6621,7 +7602,7 @@ module Aws::Kendra
6621
7602
  # @return [Array<Types::DocumentMetadataConfiguration>]
6622
7603
  #
6623
7604
  # @!attribute [rw] capacity_units
6624
- # Sets the number of addtional storage and query capacity units that
7605
+ # Sets the number of additional storage and query capacity units that
6625
7606
  # should be used by the index. You can change the capacity of the
6626
7607
  # index up to 5 times per day.
6627
7608
  #
@@ -6653,6 +7634,158 @@ module Aws::Kendra
6653
7634
  include Aws::Structure
6654
7635
  end
6655
7636
 
7637
+ # @note When making an API call, you may pass UpdateQuerySuggestionsBlockListRequest
7638
+ # data as a hash:
7639
+ #
7640
+ # {
7641
+ # index_id: "IndexId", # required
7642
+ # id: "QuerySuggestionsBlockListId", # required
7643
+ # name: "QuerySuggestionsBlockListName",
7644
+ # description: "Description",
7645
+ # source_s3_path: {
7646
+ # bucket: "S3BucketName", # required
7647
+ # key: "S3ObjectKey", # required
7648
+ # },
7649
+ # role_arn: "RoleArn",
7650
+ # }
7651
+ #
7652
+ # @!attribute [rw] index_id
7653
+ # The identifier of the index for a block list.
7654
+ # @return [String]
7655
+ #
7656
+ # @!attribute [rw] id
7657
+ # The unique identifier of a block list.
7658
+ # @return [String]
7659
+ #
7660
+ # @!attribute [rw] name
7661
+ # The name of a block list.
7662
+ # @return [String]
7663
+ #
7664
+ # @!attribute [rw] description
7665
+ # The description for a block list.
7666
+ # @return [String]
7667
+ #
7668
+ # @!attribute [rw] source_s3_path
7669
+ # The S3 path where your block list text file sits in S3.
7670
+ #
7671
+ # If you update your block list and provide the same path to the block
7672
+ # list text file in S3, then Amazon Kendra reloads the file to refresh
7673
+ # the block list. Amazon Kendra does not automatically refresh your
7674
+ # block list. You need to call the `UpdateQuerySuggestionsBlockList`
7675
+ # API to refresh you block list.
7676
+ #
7677
+ # If you update your block list, then Amazon Kendra asynchronously
7678
+ # refreshes all query suggestions with the latest content in the S3
7679
+ # file. This means changes might not take effect immediately.
7680
+ # @return [Types::S3Path]
7681
+ #
7682
+ # @!attribute [rw] role_arn
7683
+ # The IAM (Identity and Access Management) role used to access the
7684
+ # block list text file in S3.
7685
+ # @return [String]
7686
+ #
7687
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsBlockListRequest AWS API Documentation
7688
+ #
7689
+ class UpdateQuerySuggestionsBlockListRequest < Struct.new(
7690
+ :index_id,
7691
+ :id,
7692
+ :name,
7693
+ :description,
7694
+ :source_s3_path,
7695
+ :role_arn)
7696
+ SENSITIVE = []
7697
+ include Aws::Structure
7698
+ end
7699
+
7700
+ # @note When making an API call, you may pass UpdateQuerySuggestionsConfigRequest
7701
+ # data as a hash:
7702
+ #
7703
+ # {
7704
+ # index_id: "IndexId", # required
7705
+ # mode: "ENABLED", # accepts ENABLED, LEARN_ONLY
7706
+ # query_log_look_back_window_in_days: 1,
7707
+ # include_queries_without_user_information: false,
7708
+ # minimum_number_of_querying_users: 1,
7709
+ # minimum_query_count: 1,
7710
+ # }
7711
+ #
7712
+ # @!attribute [rw] index_id
7713
+ # The identifier of the index you want to update query suggestions
7714
+ # settings for.
7715
+ # @return [String]
7716
+ #
7717
+ # @!attribute [rw] mode
7718
+ # Set the mode to `ENABLED` or `LEARN_ONLY`.
7719
+ #
7720
+ # By default, Amazon Kendra enables query suggestions. `LEARN_ONLY`
7721
+ # mode allows you to turn off query suggestions. You can to update
7722
+ # this at any time.
7723
+ #
7724
+ # In `LEARN_ONLY` mode, Amazon Kendra continues to learn from new
7725
+ # queries to keep suggestions up to date for when you are ready to
7726
+ # switch to ENABLED mode again.
7727
+ # @return [String]
7728
+ #
7729
+ # @!attribute [rw] query_log_look_back_window_in_days
7730
+ # How recent your queries are in your query log time window.
7731
+ #
7732
+ # The time window is the number of days from current day to past days.
7733
+ #
7734
+ # By default, Amazon Kendra sets this to 180.
7735
+ # @return [Integer]
7736
+ #
7737
+ # @!attribute [rw] include_queries_without_user_information
7738
+ # `TRUE` to include queries without user information (i.e. all
7739
+ # queries, irrespective of the user), otherwise `FALSE` to only
7740
+ # include queries with user information.
7741
+ #
7742
+ # If you pass user information to Amazon Kendra along with the
7743
+ # queries, you can set this flag to `FALSE` and instruct Amazon Kendra
7744
+ # to only consider queries with user information.
7745
+ #
7746
+ # If you set to `FALSE`, Amazon Kendra only considers queries searched
7747
+ # at least `MinimumQueryCount` times across
7748
+ # `MinimumNumberOfQueryingUsers` unique users for suggestions.
7749
+ #
7750
+ # If you set to `TRUE`, Amazon Kendra ignores all user information and
7751
+ # learns from all queries.
7752
+ # @return [Boolean]
7753
+ #
7754
+ # @!attribute [rw] minimum_number_of_querying_users
7755
+ # The minimum number of unique users who must search a query in order
7756
+ # for the query to be eligible to suggest to your users.
7757
+ #
7758
+ # Increasing this number might decrease the number of suggestions.
7759
+ # However, this ensures a query is searched by many users and is truly
7760
+ # popular to suggest to users.
7761
+ #
7762
+ # How you tune this setting depends on your specific needs.
7763
+ # @return [Integer]
7764
+ #
7765
+ # @!attribute [rw] minimum_query_count
7766
+ # The the minimum number of times a query must be searched in order to
7767
+ # be eligible to suggest to your users.
7768
+ #
7769
+ # Decreasing this number increases the number of suggestions. However,
7770
+ # this affects the quality of suggestions as it sets a low bar for a
7771
+ # query to be considered popular to suggest to users.
7772
+ #
7773
+ # How you tune this setting depends on your specific needs.
7774
+ # @return [Integer]
7775
+ #
7776
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfigRequest AWS API Documentation
7777
+ #
7778
+ class UpdateQuerySuggestionsConfigRequest < Struct.new(
7779
+ :index_id,
7780
+ :mode,
7781
+ :query_log_look_back_window_in_days,
7782
+ :include_queries_without_user_information,
7783
+ :minimum_number_of_querying_users,
7784
+ :minimum_query_count)
7785
+ SENSITIVE = []
7786
+ include Aws::Structure
7787
+ end
7788
+
6656
7789
  # @note When making an API call, you may pass UpdateThesaurusRequest
6657
7790
  # data as a hash:
6658
7791
  #