aws-sdk-kendra 1.63.0 → 1.64.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.
@@ -536,6 +536,44 @@ module Aws::Kendra
536
536
  req.send_request(options)
537
537
  end
538
538
 
539
+ # Removes one or more sets of featured results. Features results are
540
+ # placed above all other results for certain queries. If there's an
541
+ # exact match of a query, then one or more specific documents are
542
+ # featured in the search results.
543
+ #
544
+ # @option params [required, String] :index_id
545
+ # The identifier of the index used for featuring results.
546
+ #
547
+ # @option params [required, Array<String>] :featured_results_set_ids
548
+ # The identifiers of the featured results sets that you want to delete.
549
+ #
550
+ # @return [Types::BatchDeleteFeaturedResultsSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
551
+ #
552
+ # * {Types::BatchDeleteFeaturedResultsSetResponse#errors #errors} => Array&lt;Types::BatchDeleteFeaturedResultsSetError&gt;
553
+ #
554
+ # @example Request syntax with placeholder values
555
+ #
556
+ # resp = client.batch_delete_featured_results_set({
557
+ # index_id: "IndexId", # required
558
+ # featured_results_set_ids: ["FeaturedResultsSetId"], # required
559
+ # })
560
+ #
561
+ # @example Response structure
562
+ #
563
+ # resp.errors #=> Array
564
+ # resp.errors[0].id #=> String
565
+ # resp.errors[0].error_code #=> String, one of "InternalError", "InvalidRequest"
566
+ # resp.errors[0].error_message #=> String
567
+ #
568
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteFeaturedResultsSet AWS API Documentation
569
+ #
570
+ # @overload batch_delete_featured_results_set(params = {})
571
+ # @param [Hash] params ({})
572
+ def batch_delete_featured_results_set(params = {}, options = {})
573
+ req = build_request(:batch_delete_featured_results_set, params)
574
+ req.send_request(options)
575
+ end
576
+
539
577
  # Returns the indexing status for one or more documents submitted with
540
578
  # the [ BatchPutDocument][1] API.
541
579
  #
@@ -639,8 +677,8 @@ module Aws::Kendra
639
677
  # create the index first using the `CreateIndex` API.
640
678
  #
641
679
  # @option params [String] :role_arn
642
- # The Amazon Resource Name (ARN) of a role that is allowed to run the
643
- # `BatchPutDocument` API. For more information, see [IAM Roles for
680
+ # The Amazon Resource Name (ARN) of an IAM role with permission to
681
+ # access your S3 bucket. For more information, see [IAM access roles for
644
682
  # Amazon Kendra][1].
645
683
  #
646
684
  #
@@ -652,14 +690,11 @@ module Aws::Kendra
652
690
  #
653
691
  # Documents have the following file size limits.
654
692
  #
655
- # * 5 MB total size for inline documents
656
- #
657
- # * 50 MB total size for files from an S3 bucket
693
+ # * 50 MB total size for any file
658
694
  #
659
695
  # * 5 MB extracted text for any file
660
696
  #
661
- # For more information about file size and transaction per second
662
- # quotas, see [Quotas][1].
697
+ # For more information, see [Quotas][1].
663
698
  #
664
699
  #
665
700
  #
@@ -959,19 +994,15 @@ module Aws::Kendra
959
994
  # 200 if the data source was successfully created. Otherwise, an
960
995
  # exception is raised.
961
996
  #
962
- # Amazon S3 and [custom][1] data sources are the only supported data
963
- # sources in the Amazon Web Services GovCloud (US-West) region.
964
- #
965
997
  # For an example of creating an index and data source using the Python
966
- # SDK, see [Getting started with Python SDK][2]. For an example of
998
+ # SDK, see [Getting started with Python SDK][1]. For an example of
967
999
  # creating an index and data source using the Java SDK, see [Getting
968
- # started with Java SDK][3].
1000
+ # started with Java SDK][2].
969
1001
  #
970
1002
  #
971
1003
  #
972
- # [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-custom.html
973
- # [2]: https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html
974
- # [3]: https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html
1004
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html
1005
+ # [2]: https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html
975
1006
  #
976
1007
  # @option params [required, String] :name
977
1008
  # A name for the data source connector.
@@ -1010,14 +1041,17 @@ module Aws::Kendra
1010
1041
  # schedule Amazon Kendra will not periodically update the index. You can
1011
1042
  # call the `StartDataSourceSyncJob` API to update the index.
1012
1043
  #
1044
+ # Specify a `cron-` format schedule string or an empty string to
1045
+ # indicate that the index is updated on demand.
1046
+ #
1013
1047
  # You can't specify the `Schedule` parameter when the `Type` parameter
1014
1048
  # is set to `CUSTOM`. If you do, you receive a `ValidationException`
1015
1049
  # exception.
1016
1050
  #
1017
1051
  # @option params [String] :role_arn
1018
- # The Amazon Resource Name (ARN) of a role with permission to access the
1019
- # data source and required resources. For more information, see [IAM
1020
- # roles for Amazon Kendra][1].
1052
+ # The Amazon Resource Name (ARN) of an IAM role with permission to
1053
+ # access the data source and required resources. For more information,
1054
+ # see [IAM access roles for Amazon Kendra.][1].
1021
1055
  #
1022
1056
  # You can't specify the `RoleArn` parameter when the `Type` parameter
1023
1057
  # is set to `CUSTOM`. If you do, you receive a `ValidationException`
@@ -1030,9 +1064,11 @@ module Aws::Kendra
1030
1064
  # [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
1031
1065
  #
1032
1066
  # @option params [Array<Types::Tag>] :tags
1033
- # A list of key-value pairs that identify the data source connector. You
1034
- # can use the tags to identify and organize your resources and to
1035
- # control access to resources.
1067
+ # A list of key-value pairs that identify or categorize the data source
1068
+ # connector. You can also use tags to help control access to the data
1069
+ # source connector. Tag keys and values can consist of Unicode letters,
1070
+ # digits, white space, and any of the following symbols: \_ . : / = + -
1071
+ # @.
1036
1072
  #
1037
1073
  # @option params [String] :client_token
1038
1074
  # A token that you provide to identify the request to create a data
@@ -1808,10 +1844,12 @@ module Aws::Kendra
1808
1844
  # The identifier of the index for your Amazon Kendra experience.
1809
1845
  #
1810
1846
  # @option params [String] :role_arn
1811
- # The Amazon Resource Name (ARN) of a role with permission to access
1812
- # `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and IAM
1813
- # Identity Center that stores your user and group information. For more
1814
- # information, see [IAM roles for Amazon Kendra][1].
1847
+ # The Amazon Resource Name (ARN) of an IAM role with permission to
1848
+ # access `Query` API, `GetQuerySuggestions` API, and other required
1849
+ # APIs. The role also must include permission to access IAM Identity
1850
+ # Center (successor to Single Sign-On) that stores your user and group
1851
+ # information. For more information, see [IAM access roles for Amazon
1852
+ # Kendra][1].
1815
1853
  #
1816
1854
  #
1817
1855
  #
@@ -1872,8 +1910,8 @@ module Aws::Kendra
1872
1910
  req.send_request(options)
1873
1911
  end
1874
1912
 
1875
- # Creates an new set of frequently asked question (FAQ) questions and
1876
- # answers.
1913
+ # Creates a set of frequently ask questions (FAQs) using a specified FAQ
1914
+ # file stored in an Amazon S3 bucket.
1877
1915
  #
1878
1916
  # Adding FAQs to an index is an asynchronous operation.
1879
1917
  #
@@ -1897,9 +1935,9 @@ module Aws::Kendra
1897
1935
  # The path to the FAQ file in S3.
1898
1936
  #
1899
1937
  # @option params [required, String] :role_arn
1900
- # The Amazon Resource Name (ARN) of a role with permission to access the
1901
- # S3 bucket that contains the FAQs. For more information, see [IAM Roles
1902
- # for Amazon Kendra][1].
1938
+ # The Amazon Resource Name (ARN) of an IAM role with permission to
1939
+ # access the S3 bucket that contains the FAQs. For more information, see
1940
+ # [IAM access roles for Amazon Kendra][1].
1903
1941
  #
1904
1942
  #
1905
1943
  #
@@ -1981,6 +2019,119 @@ module Aws::Kendra
1981
2019
  req.send_request(options)
1982
2020
  end
1983
2021
 
2022
+ # Creates a set of featured results to display at the top of the search
2023
+ # results page. Featured results are placed above all other results for
2024
+ # certain queries. You map specific queries to specific documents for
2025
+ # featuring in the results. If a query contains an exact match, then one
2026
+ # or more specific documents are featured in the search results.
2027
+ #
2028
+ # You can create up to 50 sets of featured results per index. You can
2029
+ # request to increase this limit by contacting [Support][1].
2030
+ #
2031
+ #
2032
+ #
2033
+ # [1]: http://aws.amazon.com/contact-us/
2034
+ #
2035
+ # @option params [required, String] :index_id
2036
+ # The identifier of the index that you want to use for featuring
2037
+ # results.
2038
+ #
2039
+ # @option params [required, String] :featured_results_set_name
2040
+ # A name for the set of featured results.
2041
+ #
2042
+ # @option params [String] :description
2043
+ # A description for the set of featured results.
2044
+ #
2045
+ # @option params [String] :client_token
2046
+ # A token that you provide to identify the request to create a set of
2047
+ # featured results. Multiple calls to the `CreateFeaturedResultsSet` API
2048
+ # with the same client token will create only one featured results set.
2049
+ #
2050
+ # @option params [String] :status
2051
+ # The current status of the set of featured results. When the value is
2052
+ # `ACTIVE`, featured results are ready for use. You can still configure
2053
+ # your settings before setting the status to `ACTIVE`. You can set the
2054
+ # status to `ACTIVE` or `INACTIVE` using the
2055
+ # [UpdateFeaturedResultsSet][1] API. The queries you specify for
2056
+ # featured results must be unique per featured results set for each
2057
+ # index, whether the status is `ACTIVE` or `INACTIVE`.
2058
+ #
2059
+ #
2060
+ #
2061
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html
2062
+ #
2063
+ # @option params [Array<String>] :query_texts
2064
+ # A list of queries for featuring results. For more information on the
2065
+ # list of queries, see [FeaturedResultsSet][1].
2066
+ #
2067
+ #
2068
+ #
2069
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html
2070
+ #
2071
+ # @option params [Array<Types::FeaturedDocument>] :featured_documents
2072
+ # A list of document IDs for the documents you want to feature at the
2073
+ # top of the search results page. For more information on the list of
2074
+ # documents, see [FeaturedResultsSet][1].
2075
+ #
2076
+ #
2077
+ #
2078
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html
2079
+ #
2080
+ # @option params [Array<Types::Tag>] :tags
2081
+ # A list of key-value pairs that identify or categorize the featured
2082
+ # results set. You can also use tags to help control access to the
2083
+ # featured results set. Tag keys and values can consist of Unicode
2084
+ # letters, digits, white space, and any of the following symbols:\_ . :
2085
+ # / = + - @.
2086
+ #
2087
+ # @return [Types::CreateFeaturedResultsSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2088
+ #
2089
+ # * {Types::CreateFeaturedResultsSetResponse#featured_results_set #featured_results_set} => Types::FeaturedResultsSet
2090
+ #
2091
+ # @example Request syntax with placeholder values
2092
+ #
2093
+ # resp = client.create_featured_results_set({
2094
+ # index_id: "IndexId", # required
2095
+ # featured_results_set_name: "FeaturedResultsSetName", # required
2096
+ # description: "FeaturedResultsSetDescription",
2097
+ # client_token: "ClientTokenName",
2098
+ # status: "ACTIVE", # accepts ACTIVE, INACTIVE
2099
+ # query_texts: ["QueryText"],
2100
+ # featured_documents: [
2101
+ # {
2102
+ # id: "DocumentId",
2103
+ # },
2104
+ # ],
2105
+ # tags: [
2106
+ # {
2107
+ # key: "TagKey", # required
2108
+ # value: "TagValue", # required
2109
+ # },
2110
+ # ],
2111
+ # })
2112
+ #
2113
+ # @example Response structure
2114
+ #
2115
+ # resp.featured_results_set.featured_results_set_id #=> String
2116
+ # resp.featured_results_set.featured_results_set_name #=> String
2117
+ # resp.featured_results_set.description #=> String
2118
+ # resp.featured_results_set.status #=> String, one of "ACTIVE", "INACTIVE"
2119
+ # resp.featured_results_set.query_texts #=> Array
2120
+ # resp.featured_results_set.query_texts[0] #=> String
2121
+ # resp.featured_results_set.featured_documents #=> Array
2122
+ # resp.featured_results_set.featured_documents[0].id #=> String
2123
+ # resp.featured_results_set.last_updated_timestamp #=> Integer
2124
+ # resp.featured_results_set.creation_timestamp #=> Integer
2125
+ #
2126
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFeaturedResultsSet AWS API Documentation
2127
+ #
2128
+ # @overload create_featured_results_set(params = {})
2129
+ # @param [Hash] params ({})
2130
+ def create_featured_results_set(params = {}, options = {})
2131
+ req = build_request(:create_featured_results_set, params)
2132
+ req.send_request(options)
2133
+ end
2134
+
1984
2135
  # Creates an Amazon Kendra index. Index creation is an asynchronous API.
1985
2136
  # To determine if index creation has completed, check the `Status` field
1986
2137
  # returned from a call to `DescribeIndex`. The `Status` field is set to
@@ -2005,14 +2156,13 @@ module Aws::Kendra
2005
2156
  # @option params [String] :edition
2006
2157
  # The Amazon Kendra edition to use for the index. Choose
2007
2158
  # `DEVELOPER_EDITION` for indexes intended for development, testing, or
2008
- # proof of concept. Use `ENTERPRISE_EDITION` for your production
2009
- # databases. Once you set the edition for an index, it can't be
2010
- # changed.
2159
+ # proof of concept. Use `ENTERPRISE_EDITION` for production. Once you
2160
+ # set the edition for an index, it can't be changed.
2011
2161
  #
2012
2162
  # The `Edition` parameter is optional. If you don't supply a value, the
2013
2163
  # default is `ENTERPRISE_EDITION`.
2014
2164
  #
2015
- # For more information on quota limits for enterprise and developer
2165
+ # For more information on quota limits for Enterprise and Developer
2016
2166
  # editions, see [Quotas][1].
2017
2167
  #
2018
2168
  #
@@ -2020,10 +2170,13 @@ module Aws::Kendra
2020
2170
  # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
2021
2171
  #
2022
2172
  # @option params [required, String] :role_arn
2023
- # An Identity and Access Management (IAM) role that gives Amazon Kendra
2024
- # permissions to access your Amazon CloudWatch logs and metrics. This is
2025
- # also the role you use when you call the `BatchPutDocument` API to
2026
- # index documents from an Amazon S3 bucket.
2173
+ # The Amazon Resource Name (ARN) of an IAM role with permission to
2174
+ # access your Amazon CloudWatch logs and metrics. For more information,
2175
+ # see [IAM access roles for Amazon Kendra][1].
2176
+ #
2177
+ #
2178
+ #
2179
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
2027
2180
  #
2028
2181
  # @option params [Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
2029
2182
  # The identifier of the KMS customer managed key (CMK) that's used to
@@ -2042,9 +2195,10 @@ module Aws::Kendra
2042
2195
  # not need to pass this option.**
2043
2196
  #
2044
2197
  # @option params [Array<Types::Tag>] :tags
2045
- # A list of key-value pairs that identify the index. You can use the
2046
- # tags to identify and organize your resources and to control access to
2047
- # resources.
2198
+ # A list of key-value pairs that identify or categorize the index. You
2199
+ # can also use tags to help control access to the index. Tag keys and
2200
+ # values can consist of Unicode letters, digits, white space, and any of
2201
+ # the following symbols: \_ . : / = + - @.
2048
2202
  #
2049
2203
  # @option params [Array<Types::UserTokenConfiguration>] :user_token_configurations
2050
2204
  # The user token configuration.
@@ -2066,9 +2220,9 @@ module Aws::Kendra
2066
2220
  # accessible to the user will be searchable and displayable.
2067
2221
  #
2068
2222
  # @option params [Types::UserGroupResolutionConfiguration] :user_group_resolution_configuration
2069
- # Enables fetching access levels of groups and users from an IAM
2070
- # Identity Center (successor to Single Sign-On) identity source. To
2071
- # configure this, see [UserGroupResolutionConfiguration][1].
2223
+ # Gets users and groups from IAM Identity Center (successor to Single
2224
+ # Sign-On) identity source. To configure this, see
2225
+ # [UserGroupResolutionConfiguration][1].
2072
2226
  #
2073
2227
  #
2074
2228
  #
@@ -2159,14 +2313,14 @@ module Aws::Kendra
2159
2313
  # block list for.
2160
2314
  #
2161
2315
  # @option params [required, String] :name
2162
- # A user friendly name for the block list.
2316
+ # A name for the block list.
2163
2317
  #
2164
- # For example, the block list named 'offensive-words' includes all
2318
+ # For example, the name 'offensive-words', which includes all
2165
2319
  # offensive words that could appear in user queries and need to be
2166
2320
  # blocked from suggestions.
2167
2321
  #
2168
2322
  # @option params [String] :description
2169
- # A user-friendly description for the block list.
2323
+ # A description for the block list.
2170
2324
  #
2171
2325
  # For example, the description "List of all offensive words that can
2172
2326
  # appear in user queries and need to be blocked from suggestions."
@@ -2191,17 +2345,18 @@ module Aws::Kendra
2191
2345
  # not need to pass this option.**
2192
2346
  #
2193
2347
  # @option params [required, String] :role_arn
2194
- # The IAM (Identity and Access Management) role used by Amazon Kendra to
2195
- # access the block list text file in your S3 bucket.
2348
+ # The Amazon Resource Name (ARN) of an IAM role with permission to
2349
+ # access your S3 bucket that contains the block list text file. For more
2350
+ # information, see [IAM access roles for Amazon Kendra][1].
2351
+ #
2352
+ #
2196
2353
  #
2197
- # You need permissions to the role ARN (Amazon Web Services Resource
2198
- # Name). The role needs S3 read permissions to your file in S3 and needs
2199
- # to give STS (Security Token Service) assume role permissions to Amazon
2200
- # Kendra.
2354
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
2201
2355
  #
2202
2356
  # @option params [Array<Types::Tag>] :tags
2203
- # A tag that you can assign to a block list that categorizes the block
2204
- # list.
2357
+ # A list of key-value pairs that identify or categorize the block list.
2358
+ # Tag keys and values can consist of Unicode letters, digits, white
2359
+ # space, and any of the following symbols: \_ . : / = + - @.
2205
2360
  #
2206
2361
  # @return [Types::CreateQuerySuggestionsBlockListResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2207
2362
  #
@@ -2260,13 +2415,19 @@ module Aws::Kendra
2260
2415
  # A description for the thesaurus.
2261
2416
  #
2262
2417
  # @option params [required, String] :role_arn
2263
- # An IAM role that gives Amazon Kendra permissions to access thesaurus
2264
- # file specified in `SourceS3Path`.
2418
+ # The Amazon Resource Name (ARN) of an IAM role with permission to
2419
+ # access your S3 bucket that contains the thesaurus file. For more
2420
+ # information, see [IAM access roles for Amazon Kendra][1].
2421
+ #
2422
+ #
2423
+ #
2424
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
2265
2425
  #
2266
2426
  # @option params [Array<Types::Tag>] :tags
2267
- # A list of key-value pairs that identify the thesaurus. You can use the
2268
- # tags to identify and organize your resources and to control access to
2269
- # resources.
2427
+ # A list of key-value pairs that identify or categorize the thesaurus.
2428
+ # You can also use tags to help control access to the thesaurus. Tag
2429
+ # keys and values can consist of Unicode letters, digits, white space,
2430
+ # and any of the following symbols: \_ . : / = + - @.
2270
2431
  #
2271
2432
  # @option params [required, Types::S3Path] :source_s3_path
2272
2433
  # The path to the thesaurus file in S3.
@@ -2507,14 +2668,14 @@ module Aws::Kendra
2507
2668
  # prevents previous actions with lower number IDs from possibly
2508
2669
  # overriding the latest action.
2509
2670
  #
2510
- # The ordering ID can be the UNIX time of the last update you made to a
2671
+ # The ordering ID can be the Unix time of the last update you made to a
2511
2672
  # group members list. You would then provide this list when calling
2512
2673
  # `PutPrincipalMapping`. This ensures your `DELETE` action for that
2513
2674
  # updated group with the latest members list doesn't get overwritten by
2514
2675
  # earlier `DELETE` actions for the same group which are yet to be
2515
2676
  # processed.
2516
2677
  #
2517
- # The default ordering ID is the current UNIX time in milliseconds that
2678
+ # The default ordering ID is the current Unix time in milliseconds that
2518
2679
  # the action was received by Amazon Kendra.
2519
2680
  #
2520
2681
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
@@ -3324,6 +3485,63 @@ module Aws::Kendra
3324
3485
  req.send_request(options)
3325
3486
  end
3326
3487
 
3488
+ # Gets information about a set of featured results. Features results are
3489
+ # placed above all other results for certain queries. If there's an
3490
+ # exact match of a query, then one or more specific documents are
3491
+ # featured in the search results.
3492
+ #
3493
+ # @option params [required, String] :index_id
3494
+ # The identifier of the index used for featuring results.
3495
+ #
3496
+ # @option params [required, String] :featured_results_set_id
3497
+ # The identifier of the set of featured results that you want to get
3498
+ # information on.
3499
+ #
3500
+ # @return [Types::DescribeFeaturedResultsSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3501
+ #
3502
+ # * {Types::DescribeFeaturedResultsSetResponse#featured_results_set_id #featured_results_set_id} => String
3503
+ # * {Types::DescribeFeaturedResultsSetResponse#featured_results_set_name #featured_results_set_name} => String
3504
+ # * {Types::DescribeFeaturedResultsSetResponse#description #description} => String
3505
+ # * {Types::DescribeFeaturedResultsSetResponse#status #status} => String
3506
+ # * {Types::DescribeFeaturedResultsSetResponse#query_texts #query_texts} => Array&lt;String&gt;
3507
+ # * {Types::DescribeFeaturedResultsSetResponse#featured_documents_with_metadata #featured_documents_with_metadata} => Array&lt;Types::FeaturedDocumentWithMetadata&gt;
3508
+ # * {Types::DescribeFeaturedResultsSetResponse#featured_documents_missing #featured_documents_missing} => Array&lt;Types::FeaturedDocumentMissing&gt;
3509
+ # * {Types::DescribeFeaturedResultsSetResponse#last_updated_timestamp #last_updated_timestamp} => Integer
3510
+ # * {Types::DescribeFeaturedResultsSetResponse#creation_timestamp #creation_timestamp} => Integer
3511
+ #
3512
+ # @example Request syntax with placeholder values
3513
+ #
3514
+ # resp = client.describe_featured_results_set({
3515
+ # index_id: "IndexId", # required
3516
+ # featured_results_set_id: "FeaturedResultsSetId", # required
3517
+ # })
3518
+ #
3519
+ # @example Response structure
3520
+ #
3521
+ # resp.featured_results_set_id #=> String
3522
+ # resp.featured_results_set_name #=> String
3523
+ # resp.description #=> String
3524
+ # resp.status #=> String, one of "ACTIVE", "INACTIVE"
3525
+ # resp.query_texts #=> Array
3526
+ # resp.query_texts[0] #=> String
3527
+ # resp.featured_documents_with_metadata #=> Array
3528
+ # resp.featured_documents_with_metadata[0].id #=> String
3529
+ # resp.featured_documents_with_metadata[0].title #=> String
3530
+ # resp.featured_documents_with_metadata[0].uri #=> String
3531
+ # resp.featured_documents_missing #=> Array
3532
+ # resp.featured_documents_missing[0].id #=> String
3533
+ # resp.last_updated_timestamp #=> Integer
3534
+ # resp.creation_timestamp #=> Integer
3535
+ #
3536
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFeaturedResultsSet AWS API Documentation
3537
+ #
3538
+ # @overload describe_featured_results_set(params = {})
3539
+ # @param [Hash] params ({})
3540
+ def describe_featured_results_set(params = {}, options = {})
3541
+ req = build_request(:describe_featured_results_set, params)
3542
+ req.send_request(options)
3543
+ end
3544
+
3327
3545
  # Gets information about an existing Amazon Kendra index.
3328
3546
  #
3329
3547
  # @option params [required, String] :id
@@ -3800,22 +4018,22 @@ module Aws::Kendra
3800
4018
  # interval uses the time zone of your index. You can view data in the
3801
4019
  # following time windows:
3802
4020
  #
3803
- # * `THIS_WEEK`\: The current week, starting on the Sunday and ending on
4021
+ # * `THIS_WEEK`: The current week, starting on the Sunday and ending on
3804
4022
  # the day before the current date.
3805
4023
  #
3806
- # * `ONE_WEEK_AGO`\: The previous week, starting on the Sunday and
3807
- # ending on the following Saturday.
4024
+ # * `ONE_WEEK_AGO`: The previous week, starting on the Sunday and ending
4025
+ # on the following Saturday.
3808
4026
  #
3809
- # * `TWO_WEEKS_AGO`\: The week before the previous week, starting on the
4027
+ # * `TWO_WEEKS_AGO`: The week before the previous week, starting on the
3810
4028
  # Sunday and ending on the following Saturday.
3811
4029
  #
3812
- # * `THIS_MONTH`\: The current month, starting on the first day of the
4030
+ # * `THIS_MONTH`: The current month, starting on the first day of the
3813
4031
  # month and ending on the day before the current date.
3814
4032
  #
3815
- # * `ONE_MONTH_AGO`\: The previous month, starting on the first day of
4033
+ # * `ONE_MONTH_AGO`: The previous month, starting on the first day of
3816
4034
  # the month and ending on the last day of the month.
3817
4035
  #
3818
- # * `TWO_MONTHS_AGO`\: The month before the previous month, starting on
4036
+ # * `TWO_MONTHS_AGO`: The month before the previous month, starting on
3819
4037
  # the first day of the month and ending on last day of the month.
3820
4038
  #
3821
4039
  # @option params [required, String] :metric_type
@@ -4266,6 +4484,54 @@ module Aws::Kendra
4266
4484
  req.send_request(options)
4267
4485
  end
4268
4486
 
4487
+ # Lists all your sets of featured results for a given index. Features
4488
+ # results are placed above all other results for certain queries. If
4489
+ # there's an exact match of a query, then one or more specific
4490
+ # documents are featured in the search results.
4491
+ #
4492
+ # @option params [required, String] :index_id
4493
+ # The identifier of the index used for featuring results.
4494
+ #
4495
+ # @option params [String] :next_token
4496
+ # If the response is truncated, Amazon Kendra returns a pagination token
4497
+ # in the response. You can use this pagination token to retrieve the
4498
+ # next set of featured results sets.
4499
+ #
4500
+ # @option params [Integer] :max_results
4501
+ # The maximum number of featured results sets to return.
4502
+ #
4503
+ # @return [Types::ListFeaturedResultsSetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4504
+ #
4505
+ # * {Types::ListFeaturedResultsSetsResponse#featured_results_set_summary_items #featured_results_set_summary_items} => Array&lt;Types::FeaturedResultsSetSummary&gt;
4506
+ # * {Types::ListFeaturedResultsSetsResponse#next_token #next_token} => String
4507
+ #
4508
+ # @example Request syntax with placeholder values
4509
+ #
4510
+ # resp = client.list_featured_results_sets({
4511
+ # index_id: "IndexId", # required
4512
+ # next_token: "NextToken",
4513
+ # max_results: 1,
4514
+ # })
4515
+ #
4516
+ # @example Response structure
4517
+ #
4518
+ # resp.featured_results_set_summary_items #=> Array
4519
+ # resp.featured_results_set_summary_items[0].featured_results_set_id #=> String
4520
+ # resp.featured_results_set_summary_items[0].featured_results_set_name #=> String
4521
+ # resp.featured_results_set_summary_items[0].status #=> String, one of "ACTIVE", "INACTIVE"
4522
+ # resp.featured_results_set_summary_items[0].last_updated_timestamp #=> Integer
4523
+ # resp.featured_results_set_summary_items[0].creation_timestamp #=> Integer
4524
+ # resp.next_token #=> String
4525
+ #
4526
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFeaturedResultsSets AWS API Documentation
4527
+ #
4528
+ # @overload list_featured_results_sets(params = {})
4529
+ # @param [Hash] params ({})
4530
+ def list_featured_results_sets(params = {}, options = {})
4531
+ req = build_request(:list_featured_results_sets, params)
4532
+ req.send_request(options)
4533
+ end
4534
+
4269
4535
  # Provides a list of groups that are mapped to users before a given
4270
4536
  # ordering or timestamp identifier.
4271
4537
  #
@@ -4537,9 +4803,6 @@ module Aws::Kendra
4537
4803
  # If more than five `PUT` actions for a group are currently processing,
4538
4804
  # a validation exception is thrown.
4539
4805
  #
4540
- # `PutPrincipalMapping` is currently not supported in the Amazon Web
4541
- # Services GovCloud (US-West) region.
4542
- #
4543
4806
  #
4544
4807
  #
4545
4808
  # [1]: https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html
@@ -4583,13 +4846,13 @@ module Aws::Kendra
4583
4846
  # prevents previous actions with lower number IDs from possibly
4584
4847
  # overriding the latest action.
4585
4848
  #
4586
- # The ordering ID can be the UNIX time of the last update you made to a
4849
+ # The ordering ID can be the Unix time of the last update you made to a
4587
4850
  # group members list. You would then provide this list when calling
4588
4851
  # `PutPrincipalMapping`. This ensures your `PUT` action for that updated
4589
4852
  # group with the latest members list doesn't get overwritten by earlier
4590
4853
  # `PUT` actions for the same group which are yet to be processed.
4591
4854
  #
4592
- # The default ordering ID is the current UNIX time in milliseconds that
4855
+ # The default ordering ID is the current Unix time in milliseconds that
4593
4856
  # the action was received by Amazon Kendra.
4594
4857
  #
4595
4858
  # @option params [String] :role_arn
@@ -4754,6 +5017,7 @@ module Aws::Kendra
4754
5017
  # * {Types::QueryResult#total_number_of_results #total_number_of_results} => Integer
4755
5018
  # * {Types::QueryResult#warnings #warnings} => Array&lt;Types::Warning&gt;
4756
5019
  # * {Types::QueryResult#spell_corrected_queries #spell_corrected_queries} => Array&lt;Types::SpellCorrectedQuery&gt;
5020
+ # * {Types::QueryResult#featured_results_items #featured_results_items} => Array&lt;Types::FeaturedResultsItem&gt;
4757
5021
  #
4758
5022
  # @example Request syntax with placeholder values
4759
5023
  #
@@ -4954,6 +5218,40 @@ module Aws::Kendra
4954
5218
  # resp.spell_corrected_queries[0].corrections[0].end_offset #=> Integer
4955
5219
  # resp.spell_corrected_queries[0].corrections[0].term #=> String
4956
5220
  # resp.spell_corrected_queries[0].corrections[0].corrected_term #=> String
5221
+ # resp.featured_results_items #=> Array
5222
+ # resp.featured_results_items[0].id #=> String
5223
+ # resp.featured_results_items[0].type #=> String, one of "DOCUMENT", "QUESTION_ANSWER", "ANSWER"
5224
+ # resp.featured_results_items[0].additional_attributes #=> Array
5225
+ # resp.featured_results_items[0].additional_attributes[0].key #=> String
5226
+ # resp.featured_results_items[0].additional_attributes[0].value_type #=> String, one of "TEXT_WITH_HIGHLIGHTS_VALUE"
5227
+ # resp.featured_results_items[0].additional_attributes[0].value.text_with_highlights_value.text #=> String
5228
+ # resp.featured_results_items[0].additional_attributes[0].value.text_with_highlights_value.highlights #=> Array
5229
+ # resp.featured_results_items[0].additional_attributes[0].value.text_with_highlights_value.highlights[0].begin_offset #=> Integer
5230
+ # resp.featured_results_items[0].additional_attributes[0].value.text_with_highlights_value.highlights[0].end_offset #=> Integer
5231
+ # resp.featured_results_items[0].additional_attributes[0].value.text_with_highlights_value.highlights[0].top_answer #=> Boolean
5232
+ # resp.featured_results_items[0].additional_attributes[0].value.text_with_highlights_value.highlights[0].type #=> String, one of "STANDARD", "THESAURUS_SYNONYM"
5233
+ # resp.featured_results_items[0].document_id #=> String
5234
+ # resp.featured_results_items[0].document_title.text #=> String
5235
+ # resp.featured_results_items[0].document_title.highlights #=> Array
5236
+ # resp.featured_results_items[0].document_title.highlights[0].begin_offset #=> Integer
5237
+ # resp.featured_results_items[0].document_title.highlights[0].end_offset #=> Integer
5238
+ # resp.featured_results_items[0].document_title.highlights[0].top_answer #=> Boolean
5239
+ # resp.featured_results_items[0].document_title.highlights[0].type #=> String, one of "STANDARD", "THESAURUS_SYNONYM"
5240
+ # resp.featured_results_items[0].document_excerpt.text #=> String
5241
+ # resp.featured_results_items[0].document_excerpt.highlights #=> Array
5242
+ # resp.featured_results_items[0].document_excerpt.highlights[0].begin_offset #=> Integer
5243
+ # resp.featured_results_items[0].document_excerpt.highlights[0].end_offset #=> Integer
5244
+ # resp.featured_results_items[0].document_excerpt.highlights[0].top_answer #=> Boolean
5245
+ # resp.featured_results_items[0].document_excerpt.highlights[0].type #=> String, one of "STANDARD", "THESAURUS_SYNONYM"
5246
+ # resp.featured_results_items[0].document_uri #=> String
5247
+ # resp.featured_results_items[0].document_attributes #=> Array
5248
+ # resp.featured_results_items[0].document_attributes[0].key #=> String
5249
+ # resp.featured_results_items[0].document_attributes[0].value.string_value #=> String
5250
+ # resp.featured_results_items[0].document_attributes[0].value.string_list_value #=> Array
5251
+ # resp.featured_results_items[0].document_attributes[0].value.string_list_value[0] #=> String
5252
+ # resp.featured_results_items[0].document_attributes[0].value.long_value #=> Integer
5253
+ # resp.featured_results_items[0].document_attributes[0].value.date_value #=> Time
5254
+ # resp.featured_results_items[0].feedback_token #=> String
4957
5255
  #
4958
5256
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Query AWS API Documentation
4959
5257
  #
@@ -6077,6 +6375,90 @@ module Aws::Kendra
6077
6375
  req.send_request(options)
6078
6376
  end
6079
6377
 
6378
+ # Updates a set of featured results. Features results are placed above
6379
+ # all other results for certain queries. You map specific queries to
6380
+ # specific documents for featuring in the results. If a query contains
6381
+ # an exact match of a query, then one or more specific documents are
6382
+ # featured in the search results.
6383
+ #
6384
+ # @option params [required, String] :index_id
6385
+ # The identifier of the index used for featuring results.
6386
+ #
6387
+ # @option params [required, String] :featured_results_set_id
6388
+ # The identifier of the index used for featuring results.
6389
+ #
6390
+ # @option params [String] :featured_results_set_name
6391
+ # A new name for the set of featured results.
6392
+ #
6393
+ # @option params [String] :description
6394
+ # A new description for the set of featured results.
6395
+ #
6396
+ # @option params [String] :status
6397
+ # You can set the status to `ACTIVE` or `INACTIVE`. When the value is
6398
+ # `ACTIVE`, featured results are ready for use. You can still configure
6399
+ # your settings before setting the status to `ACTIVE`. The queries you
6400
+ # specify for featured results must be unique per featured results set
6401
+ # for each index, whether the status is `ACTIVE` or `INACTIVE`.
6402
+ #
6403
+ # @option params [Array<String>] :query_texts
6404
+ # A list of queries for featuring results. For more information on the
6405
+ # list of queries, see [FeaturedResultsSet][1].
6406
+ #
6407
+ #
6408
+ #
6409
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html
6410
+ #
6411
+ # @option params [Array<Types::FeaturedDocument>] :featured_documents
6412
+ # A list of document IDs for the documents you want to feature at the
6413
+ # top of the search results page. For more information on the list of
6414
+ # featured documents, see [FeaturedResultsSet][1].
6415
+ #
6416
+ #
6417
+ #
6418
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html
6419
+ #
6420
+ # @return [Types::UpdateFeaturedResultsSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6421
+ #
6422
+ # * {Types::UpdateFeaturedResultsSetResponse#featured_results_set #featured_results_set} => Types::FeaturedResultsSet
6423
+ #
6424
+ # @example Request syntax with placeholder values
6425
+ #
6426
+ # resp = client.update_featured_results_set({
6427
+ # index_id: "IndexId", # required
6428
+ # featured_results_set_id: "FeaturedResultsSetId", # required
6429
+ # featured_results_set_name: "FeaturedResultsSetName",
6430
+ # description: "FeaturedResultsSetDescription",
6431
+ # status: "ACTIVE", # accepts ACTIVE, INACTIVE
6432
+ # query_texts: ["QueryText"],
6433
+ # featured_documents: [
6434
+ # {
6435
+ # id: "DocumentId",
6436
+ # },
6437
+ # ],
6438
+ # })
6439
+ #
6440
+ # @example Response structure
6441
+ #
6442
+ # resp.featured_results_set.featured_results_set_id #=> String
6443
+ # resp.featured_results_set.featured_results_set_name #=> String
6444
+ # resp.featured_results_set.description #=> String
6445
+ # resp.featured_results_set.status #=> String, one of "ACTIVE", "INACTIVE"
6446
+ # resp.featured_results_set.query_texts #=> Array
6447
+ # resp.featured_results_set.query_texts[0] #=> String
6448
+ # resp.featured_results_set.featured_documents #=> Array
6449
+ # resp.featured_results_set.featured_documents[0].id #=> String
6450
+ # resp.featured_results_set.last_updated_timestamp #=> Integer
6451
+ # resp.featured_results_set.creation_timestamp #=> Integer
6452
+ #
6453
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateFeaturedResultsSet AWS API Documentation
6454
+ #
6455
+ # @overload update_featured_results_set(params = {})
6456
+ # @param [Hash] params ({})
6457
+ def update_featured_results_set(params = {}, options = {})
6458
+ req = build_request(:update_featured_results_set, params)
6459
+ req.send_request(options)
6460
+ end
6461
+
6080
6462
  # Updates an existing Amazon Kendra index.
6081
6463
  #
6082
6464
  # @option params [required, String] :id
@@ -6413,7 +6795,7 @@ module Aws::Kendra
6413
6795
  params: params,
6414
6796
  config: config)
6415
6797
  context[:gem_name] = 'aws-sdk-kendra'
6416
- context[:gem_version] = '1.63.0'
6798
+ context[:gem_version] = '1.64.0'
6417
6799
  Seahorse::Client::Request.new(handlers, context)
6418
6800
  end
6419
6801