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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra/client.rb +457 -75
- data/lib/aws-sdk-kendra/client_api.rb +229 -0
- data/lib/aws-sdk-kendra/endpoint_parameters.rb +0 -3
- data/lib/aws-sdk-kendra/endpoint_provider.rb +27 -24
- data/lib/aws-sdk-kendra/endpoints.rb +70 -0
- data/lib/aws-sdk-kendra/errors.rb +21 -0
- data/lib/aws-sdk-kendra/plugins/endpoints.rb +10 -0
- data/lib/aws-sdk-kendra/types.rb +896 -165
- data/lib/aws-sdk-kendra.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -556,6 +556,69 @@ module Aws::Kendra
|
|
556
556
|
include Aws::Structure
|
557
557
|
end
|
558
558
|
|
559
|
+
# Provides information about a set of featured results that couldn't be
|
560
|
+
# removed from an index by the [BatchDeleteFeaturedResultsSet][1] API.
|
561
|
+
#
|
562
|
+
#
|
563
|
+
#
|
564
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteFeaturedResultsSet.html
|
565
|
+
#
|
566
|
+
# @!attribute [rw] id
|
567
|
+
# The identifier of the set of featured results that couldn't be
|
568
|
+
# removed from the index.
|
569
|
+
# @return [String]
|
570
|
+
#
|
571
|
+
# @!attribute [rw] error_code
|
572
|
+
# The error code for why the set of featured results couldn't be
|
573
|
+
# removed from the index.
|
574
|
+
# @return [String]
|
575
|
+
#
|
576
|
+
# @!attribute [rw] error_message
|
577
|
+
# An explanation for why the set of featured results couldn't be
|
578
|
+
# removed from the index.
|
579
|
+
# @return [String]
|
580
|
+
#
|
581
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteFeaturedResultsSetError AWS API Documentation
|
582
|
+
#
|
583
|
+
class BatchDeleteFeaturedResultsSetError < Struct.new(
|
584
|
+
:id,
|
585
|
+
:error_code,
|
586
|
+
:error_message)
|
587
|
+
SENSITIVE = []
|
588
|
+
include Aws::Structure
|
589
|
+
end
|
590
|
+
|
591
|
+
# @!attribute [rw] index_id
|
592
|
+
# The identifier of the index used for featuring results.
|
593
|
+
# @return [String]
|
594
|
+
#
|
595
|
+
# @!attribute [rw] featured_results_set_ids
|
596
|
+
# The identifiers of the featured results sets that you want to
|
597
|
+
# delete.
|
598
|
+
# @return [Array<String>]
|
599
|
+
#
|
600
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteFeaturedResultsSetRequest AWS API Documentation
|
601
|
+
#
|
602
|
+
class BatchDeleteFeaturedResultsSetRequest < Struct.new(
|
603
|
+
:index_id,
|
604
|
+
:featured_results_set_ids)
|
605
|
+
SENSITIVE = []
|
606
|
+
include Aws::Structure
|
607
|
+
end
|
608
|
+
|
609
|
+
# @!attribute [rw] errors
|
610
|
+
# The list of errors for the featured results set IDs, explaining why
|
611
|
+
# they couldn't be removed from the index.
|
612
|
+
# @return [Array<Types::BatchDeleteFeaturedResultsSetError>]
|
613
|
+
#
|
614
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchDeleteFeaturedResultsSetResponse AWS API Documentation
|
615
|
+
#
|
616
|
+
class BatchDeleteFeaturedResultsSetResponse < Struct.new(
|
617
|
+
:errors)
|
618
|
+
SENSITIVE = []
|
619
|
+
include Aws::Structure
|
620
|
+
end
|
621
|
+
|
559
622
|
# @!attribute [rw] index_id
|
560
623
|
# The identifier of the index to add documents to. The index ID is
|
561
624
|
# returned by the [CreateIndex ][1] API.
|
@@ -635,9 +698,9 @@ module Aws::Kendra
|
|
635
698
|
# @return [String]
|
636
699
|
#
|
637
700
|
# @!attribute [rw] role_arn
|
638
|
-
# The Amazon Resource Name (ARN) of
|
639
|
-
#
|
640
|
-
# Amazon Kendra][1].
|
701
|
+
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
702
|
+
# access your S3 bucket. For more information, see [IAM access roles
|
703
|
+
# for Amazon Kendra][1].
|
641
704
|
#
|
642
705
|
#
|
643
706
|
#
|
@@ -649,14 +712,11 @@ module Aws::Kendra
|
|
649
712
|
#
|
650
713
|
# Documents have the following file size limits.
|
651
714
|
#
|
652
|
-
# *
|
653
|
-
#
|
654
|
-
# * 50 MB total size for files from an S3 bucket
|
715
|
+
# * 50 MB total size for any file
|
655
716
|
#
|
656
717
|
# * 5 MB extracted text for any file
|
657
718
|
#
|
658
|
-
# For more information
|
659
|
-
# quotas, see [Quotas][1].
|
719
|
+
# For more information, see [Quotas][1].
|
660
720
|
#
|
661
721
|
#
|
662
722
|
#
|
@@ -958,7 +1018,7 @@ module Aws::Kendra
|
|
958
1018
|
# @return [String]
|
959
1019
|
#
|
960
1020
|
# @!attribute [rw] click_time
|
961
|
-
# The Unix timestamp
|
1021
|
+
# The Unix timestamp when the result was clicked.
|
962
1022
|
# @return [Time]
|
963
1023
|
#
|
964
1024
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ClickFeedback AWS API Documentation
|
@@ -1022,6 +1082,35 @@ module Aws::Kendra
|
|
1022
1082
|
include Aws::Structure
|
1023
1083
|
end
|
1024
1084
|
|
1085
|
+
# Information about a conflicting query used across different sets of
|
1086
|
+
# featured results. When you create a featured results set, you must
|
1087
|
+
# check that the queries are unique per featured results set for each
|
1088
|
+
# index.
|
1089
|
+
#
|
1090
|
+
# @!attribute [rw] query_text
|
1091
|
+
# The text of the conflicting query.
|
1092
|
+
# @return [String]
|
1093
|
+
#
|
1094
|
+
# @!attribute [rw] set_name
|
1095
|
+
# The name for the set of featured results that the conflicting query
|
1096
|
+
# belongs to.
|
1097
|
+
# @return [String]
|
1098
|
+
#
|
1099
|
+
# @!attribute [rw] set_id
|
1100
|
+
# The identifier of the set of featured results that the conflicting
|
1101
|
+
# query belongs to.
|
1102
|
+
# @return [String]
|
1103
|
+
#
|
1104
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConflictingItem AWS API Documentation
|
1105
|
+
#
|
1106
|
+
class ConflictingItem < Struct.new(
|
1107
|
+
:query_text,
|
1108
|
+
:set_name,
|
1109
|
+
:set_id)
|
1110
|
+
SENSITIVE = []
|
1111
|
+
include Aws::Structure
|
1112
|
+
end
|
1113
|
+
|
1025
1114
|
# Configuration of attachment settings for the Confluence data source.
|
1026
1115
|
# Attachment settings are optional, if you don't specify settings
|
1027
1116
|
# attachments, Amazon Kendra won't index them.
|
@@ -1655,15 +1744,18 @@ module Aws::Kendra
|
|
1655
1744
|
# schedule Amazon Kendra will not periodically update the index. You
|
1656
1745
|
# can call the `StartDataSourceSyncJob` API to update the index.
|
1657
1746
|
#
|
1747
|
+
# Specify a `cron-` format schedule string or an empty string to
|
1748
|
+
# indicate that the index is updated on demand.
|
1749
|
+
#
|
1658
1750
|
# You can't specify the `Schedule` parameter when the `Type`
|
1659
1751
|
# parameter is set to `CUSTOM`. If you do, you receive a
|
1660
1752
|
# `ValidationException` exception.
|
1661
1753
|
# @return [String]
|
1662
1754
|
#
|
1663
1755
|
# @!attribute [rw] role_arn
|
1664
|
-
# The Amazon Resource Name (ARN) of
|
1665
|
-
# the data source and required resources. For more information,
|
1666
|
-
# [IAM roles for Amazon Kendra][1].
|
1756
|
+
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
1757
|
+
# access the data source and required resources. For more information,
|
1758
|
+
# see [IAM access roles for Amazon Kendra.][1].
|
1667
1759
|
#
|
1668
1760
|
# You can't specify the `RoleArn` parameter when the `Type` parameter
|
1669
1761
|
# is set to `CUSTOM`. If you do, you receive a `ValidationException`
|
@@ -1677,9 +1769,11 @@ module Aws::Kendra
|
|
1677
1769
|
# @return [String]
|
1678
1770
|
#
|
1679
1771
|
# @!attribute [rw] tags
|
1680
|
-
# A list of key-value pairs that identify the data
|
1681
|
-
# You can use
|
1682
|
-
#
|
1772
|
+
# A list of key-value pairs that identify or categorize the data
|
1773
|
+
# source connector. You can also use tags to help control access to
|
1774
|
+
# the data source connector. Tag keys and values can consist of
|
1775
|
+
# Unicode letters, digits, white space, and any of the following
|
1776
|
+
# symbols: \_ . : / = + - @.
|
1683
1777
|
# @return [Array<Types::Tag>]
|
1684
1778
|
#
|
1685
1779
|
# @!attribute [rw] client_token
|
@@ -1757,10 +1851,12 @@ module Aws::Kendra
|
|
1757
1851
|
# @return [String]
|
1758
1852
|
#
|
1759
1853
|
# @!attribute [rw] role_arn
|
1760
|
-
# The Amazon Resource Name (ARN) of
|
1761
|
-
# `Query` API, `
|
1762
|
-
#
|
1763
|
-
#
|
1854
|
+
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
1855
|
+
# access `Query` API, `GetQuerySuggestions` API, and other required
|
1856
|
+
# APIs. The role also must include permission to access IAM Identity
|
1857
|
+
# Center (successor to Single Sign-On) that stores your user and group
|
1858
|
+
# information. For more information, see [IAM access roles for Amazon
|
1859
|
+
# Kendra][1].
|
1764
1860
|
#
|
1765
1861
|
#
|
1766
1862
|
#
|
@@ -1803,7 +1899,7 @@ module Aws::Kendra
|
|
1803
1899
|
end
|
1804
1900
|
|
1805
1901
|
# @!attribute [rw] id
|
1806
|
-
# The identifier
|
1902
|
+
# The identifier of your Amazon Kendra experience.
|
1807
1903
|
# @return [String]
|
1808
1904
|
#
|
1809
1905
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateExperienceResponse AWS API Documentation
|
@@ -1831,9 +1927,9 @@ module Aws::Kendra
|
|
1831
1927
|
# @return [Types::S3Path]
|
1832
1928
|
#
|
1833
1929
|
# @!attribute [rw] role_arn
|
1834
|
-
# The Amazon Resource Name (ARN) of
|
1835
|
-
# the S3 bucket that contains the FAQs. For more information,
|
1836
|
-
#
|
1930
|
+
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
1931
|
+
# access the S3 bucket that contains the FAQs. For more information,
|
1932
|
+
# see [IAM access roles for Amazon Kendra][1].
|
1837
1933
|
#
|
1838
1934
|
#
|
1839
1935
|
#
|
@@ -1909,6 +2005,97 @@ module Aws::Kendra
|
|
1909
2005
|
include Aws::Structure
|
1910
2006
|
end
|
1911
2007
|
|
2008
|
+
# @!attribute [rw] index_id
|
2009
|
+
# The identifier of the index that you want to use for featuring
|
2010
|
+
# results.
|
2011
|
+
# @return [String]
|
2012
|
+
#
|
2013
|
+
# @!attribute [rw] featured_results_set_name
|
2014
|
+
# A name for the set of featured results.
|
2015
|
+
# @return [String]
|
2016
|
+
#
|
2017
|
+
# @!attribute [rw] description
|
2018
|
+
# A description for the set of featured results.
|
2019
|
+
# @return [String]
|
2020
|
+
#
|
2021
|
+
# @!attribute [rw] client_token
|
2022
|
+
# A token that you provide to identify the request to create a set of
|
2023
|
+
# featured results. Multiple calls to the `CreateFeaturedResultsSet`
|
2024
|
+
# API with the same client token will create only one featured results
|
2025
|
+
# set.
|
2026
|
+
# @return [String]
|
2027
|
+
#
|
2028
|
+
# @!attribute [rw] status
|
2029
|
+
# The current status of the set of featured results. When the value is
|
2030
|
+
# `ACTIVE`, featured results are ready for use. You can still
|
2031
|
+
# configure your settings before setting the status to `ACTIVE`. You
|
2032
|
+
# can set the status to `ACTIVE` or `INACTIVE` using the
|
2033
|
+
# [UpdateFeaturedResultsSet][1] API. The queries you specify for
|
2034
|
+
# featured results must be unique per featured results set for each
|
2035
|
+
# index, whether the status is `ACTIVE` or `INACTIVE`.
|
2036
|
+
#
|
2037
|
+
#
|
2038
|
+
#
|
2039
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html
|
2040
|
+
# @return [String]
|
2041
|
+
#
|
2042
|
+
# @!attribute [rw] query_texts
|
2043
|
+
# A list of queries for featuring results. For more information on the
|
2044
|
+
# list of queries, see [FeaturedResultsSet][1].
|
2045
|
+
#
|
2046
|
+
#
|
2047
|
+
#
|
2048
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html
|
2049
|
+
# @return [Array<String>]
|
2050
|
+
#
|
2051
|
+
# @!attribute [rw] featured_documents
|
2052
|
+
# A list of document IDs for the documents you want to feature at the
|
2053
|
+
# top of the search results page. For more information on the list of
|
2054
|
+
# documents, see [FeaturedResultsSet][1].
|
2055
|
+
#
|
2056
|
+
#
|
2057
|
+
#
|
2058
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html
|
2059
|
+
# @return [Array<Types::FeaturedDocument>]
|
2060
|
+
#
|
2061
|
+
# @!attribute [rw] tags
|
2062
|
+
# A list of key-value pairs that identify or categorize the featured
|
2063
|
+
# results set. You can also use tags to help control access to the
|
2064
|
+
# featured results set. Tag keys and values can consist of Unicode
|
2065
|
+
# letters, digits, white space, and any of the following symbols:\_ .
|
2066
|
+
# \: / = + - @.
|
2067
|
+
# @return [Array<Types::Tag>]
|
2068
|
+
#
|
2069
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFeaturedResultsSetRequest AWS API Documentation
|
2070
|
+
#
|
2071
|
+
class CreateFeaturedResultsSetRequest < Struct.new(
|
2072
|
+
:index_id,
|
2073
|
+
:featured_results_set_name,
|
2074
|
+
:description,
|
2075
|
+
:client_token,
|
2076
|
+
:status,
|
2077
|
+
:query_texts,
|
2078
|
+
:featured_documents,
|
2079
|
+
:tags)
|
2080
|
+
SENSITIVE = []
|
2081
|
+
include Aws::Structure
|
2082
|
+
end
|
2083
|
+
|
2084
|
+
# @!attribute [rw] featured_results_set
|
2085
|
+
# Information on the set of featured results. This includes the
|
2086
|
+
# identifier of the featured results set, whether the featured results
|
2087
|
+
# set is active or inactive, when the featured results set was
|
2088
|
+
# created, and more.
|
2089
|
+
# @return [Types::FeaturedResultsSet]
|
2090
|
+
#
|
2091
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFeaturedResultsSetResponse AWS API Documentation
|
2092
|
+
#
|
2093
|
+
class CreateFeaturedResultsSetResponse < Struct.new(
|
2094
|
+
:featured_results_set)
|
2095
|
+
SENSITIVE = []
|
2096
|
+
include Aws::Structure
|
2097
|
+
end
|
2098
|
+
|
1912
2099
|
# @!attribute [rw] name
|
1913
2100
|
# A name for the index.
|
1914
2101
|
# @return [String]
|
@@ -1916,14 +2103,13 @@ module Aws::Kendra
|
|
1916
2103
|
# @!attribute [rw] edition
|
1917
2104
|
# The Amazon Kendra edition to use for the index. Choose
|
1918
2105
|
# `DEVELOPER_EDITION` for indexes intended for development, testing,
|
1919
|
-
# or proof of concept. Use `ENTERPRISE_EDITION` for
|
1920
|
-
#
|
1921
|
-
# changed.
|
2106
|
+
# or proof of concept. Use `ENTERPRISE_EDITION` for production. Once
|
2107
|
+
# you set the edition for an index, it can't be changed.
|
1922
2108
|
#
|
1923
2109
|
# The `Edition` parameter is optional. If you don't supply a value,
|
1924
2110
|
# the default is `ENTERPRISE_EDITION`.
|
1925
2111
|
#
|
1926
|
-
# For more information on quota limits for
|
2112
|
+
# For more information on quota limits for Enterprise and Developer
|
1927
2113
|
# editions, see [Quotas][1].
|
1928
2114
|
#
|
1929
2115
|
#
|
@@ -1932,10 +2118,13 @@ module Aws::Kendra
|
|
1932
2118
|
# @return [String]
|
1933
2119
|
#
|
1934
2120
|
# @!attribute [rw] role_arn
|
1935
|
-
#
|
1936
|
-
#
|
1937
|
-
#
|
1938
|
-
#
|
2121
|
+
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
2122
|
+
# access your Amazon CloudWatch logs and metrics. For more
|
2123
|
+
# information, see [IAM access roles for Amazon Kendra][1].
|
2124
|
+
#
|
2125
|
+
#
|
2126
|
+
#
|
2127
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
1939
2128
|
# @return [String]
|
1940
2129
|
#
|
1941
2130
|
# @!attribute [rw] server_side_encryption_configuration
|
@@ -1958,9 +2147,10 @@ module Aws::Kendra
|
|
1958
2147
|
# @return [String]
|
1959
2148
|
#
|
1960
2149
|
# @!attribute [rw] tags
|
1961
|
-
# A list of key-value pairs that identify the index. You
|
1962
|
-
# tags to
|
1963
|
-
#
|
2150
|
+
# A list of key-value pairs that identify or categorize the index. You
|
2151
|
+
# can also use tags to help control access to the index. Tag keys and
|
2152
|
+
# values can consist of Unicode letters, digits, white space, and any
|
2153
|
+
# of the following symbols: \_ . : / = + - @.
|
1964
2154
|
# @return [Array<Types::Tag>]
|
1965
2155
|
#
|
1966
2156
|
# @!attribute [rw] user_token_configurations
|
@@ -1986,9 +2176,9 @@ module Aws::Kendra
|
|
1986
2176
|
# @return [String]
|
1987
2177
|
#
|
1988
2178
|
# @!attribute [rw] user_group_resolution_configuration
|
1989
|
-
#
|
1990
|
-
#
|
1991
|
-
#
|
2179
|
+
# Gets users and groups from IAM Identity Center (successor to Single
|
2180
|
+
# Sign-On) identity source. To configure this, see
|
2181
|
+
# [UserGroupResolutionConfiguration][1].
|
1992
2182
|
#
|
1993
2183
|
#
|
1994
2184
|
#
|
@@ -2031,15 +2221,15 @@ module Aws::Kendra
|
|
2031
2221
|
# @return [String]
|
2032
2222
|
#
|
2033
2223
|
# @!attribute [rw] name
|
2034
|
-
# A
|
2224
|
+
# A name for the block list.
|
2035
2225
|
#
|
2036
|
-
# For example, the
|
2226
|
+
# For example, the name 'offensive-words', which includes all
|
2037
2227
|
# offensive words that could appear in user queries and need to be
|
2038
2228
|
# blocked from suggestions.
|
2039
2229
|
# @return [String]
|
2040
2230
|
#
|
2041
2231
|
# @!attribute [rw] description
|
2042
|
-
# A
|
2232
|
+
# A description for the block list.
|
2043
2233
|
#
|
2044
2234
|
# For example, the description "List of all offensive words that can
|
2045
2235
|
# appear in user queries and need to be blocked from suggestions."
|
@@ -2068,18 +2258,19 @@ module Aws::Kendra
|
|
2068
2258
|
# @return [String]
|
2069
2259
|
#
|
2070
2260
|
# @!attribute [rw] role_arn
|
2071
|
-
# The
|
2072
|
-
#
|
2261
|
+
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
2262
|
+
# access your S3 bucket that contains the block list text file. For
|
2263
|
+
# more information, see [IAM access roles for Amazon Kendra][1].
|
2264
|
+
#
|
2265
|
+
#
|
2073
2266
|
#
|
2074
|
-
#
|
2075
|
-
# Name). The role needs S3 read permissions to your file in S3 and
|
2076
|
-
# needs to give STS (Security Token Service) assume role permissions
|
2077
|
-
# to Amazon Kendra.
|
2267
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
2078
2268
|
# @return [String]
|
2079
2269
|
#
|
2080
2270
|
# @!attribute [rw] tags
|
2081
|
-
# A
|
2082
|
-
# list.
|
2271
|
+
# A list of key-value pairs that identify or categorize the block
|
2272
|
+
# list. Tag keys and values can consist of Unicode letters, digits,
|
2273
|
+
# white space, and any of the following symbols: \_ . : / = + - @.
|
2083
2274
|
# @return [Array<Types::Tag>]
|
2084
2275
|
#
|
2085
2276
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockListRequest AWS API Documentation
|
@@ -2097,7 +2288,7 @@ module Aws::Kendra
|
|
2097
2288
|
end
|
2098
2289
|
|
2099
2290
|
# @!attribute [rw] id
|
2100
|
-
# The identifier of the
|
2291
|
+
# The identifier of the block list.
|
2101
2292
|
# @return [String]
|
2102
2293
|
#
|
2103
2294
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateQuerySuggestionsBlockListResponse AWS API Documentation
|
@@ -2121,14 +2312,20 @@ module Aws::Kendra
|
|
2121
2312
|
# @return [String]
|
2122
2313
|
#
|
2123
2314
|
# @!attribute [rw] role_arn
|
2124
|
-
#
|
2125
|
-
# file
|
2315
|
+
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
2316
|
+
# access your S3 bucket that contains the thesaurus file. For more
|
2317
|
+
# information, see [IAM access roles for Amazon Kendra][1].
|
2318
|
+
#
|
2319
|
+
#
|
2320
|
+
#
|
2321
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
2126
2322
|
# @return [String]
|
2127
2323
|
#
|
2128
2324
|
# @!attribute [rw] tags
|
2129
|
-
# A list of key-value pairs that identify the thesaurus.
|
2130
|
-
#
|
2131
|
-
#
|
2325
|
+
# A list of key-value pairs that identify or categorize the thesaurus.
|
2326
|
+
# You can also use tags to help control access to the thesaurus. Tag
|
2327
|
+
# keys and values can consist of Unicode letters, digits, white space,
|
2328
|
+
# and any of the following symbols: \_ . : / = + - @.
|
2132
2329
|
# @return [Array<Types::Tag>]
|
2133
2330
|
#
|
2134
2331
|
# @!attribute [rw] source_s3_path
|
@@ -2388,11 +2585,11 @@ module Aws::Kendra
|
|
2388
2585
|
# @return [String]
|
2389
2586
|
#
|
2390
2587
|
# @!attribute [rw] created_at
|
2391
|
-
# The
|
2588
|
+
# The Unix timestamp when the data source connector was created.
|
2392
2589
|
# @return [Time]
|
2393
2590
|
#
|
2394
2591
|
# @!attribute [rw] updated_at
|
2395
|
-
# The
|
2592
|
+
# The Unix timestamp when the data source connector was last updated.
|
2396
2593
|
# @return [Time]
|
2397
2594
|
#
|
2398
2595
|
# @!attribute [rw] status
|
@@ -2432,11 +2629,11 @@ module Aws::Kendra
|
|
2432
2629
|
# @return [String]
|
2433
2630
|
#
|
2434
2631
|
# @!attribute [rw] start_time
|
2435
|
-
# The
|
2632
|
+
# The Unix timestamp when the synchronization job started.
|
2436
2633
|
# @return [Time]
|
2437
2634
|
#
|
2438
2635
|
# @!attribute [rw] end_time
|
2439
|
-
# The
|
2636
|
+
# The Unix timestamp when the synchronization job completed.
|
2440
2637
|
# @return [Time]
|
2441
2638
|
#
|
2442
2639
|
# @!attribute [rw] status
|
@@ -2762,14 +2959,14 @@ module Aws::Kendra
|
|
2762
2959
|
# number IDs. This prevents previous actions with lower number IDs
|
2763
2960
|
# from possibly overriding the latest action.
|
2764
2961
|
#
|
2765
|
-
# The ordering ID can be the
|
2962
|
+
# The ordering ID can be the Unix time of the last update you made to
|
2766
2963
|
# a group members list. You would then provide this list when calling
|
2767
2964
|
# `PutPrincipalMapping`. This ensures your `DELETE` action for that
|
2768
2965
|
# updated group with the latest members list doesn't get overwritten
|
2769
2966
|
# by earlier `DELETE` actions for the same group which are yet to be
|
2770
2967
|
# processed.
|
2771
2968
|
#
|
2772
|
-
# The default ordering ID is the current
|
2969
|
+
# The default ordering ID is the current Unix time in milliseconds
|
2773
2970
|
# that the action was received by Amazon Kendra.
|
2774
2971
|
# @return [Integer]
|
2775
2972
|
#
|
@@ -2927,12 +3124,11 @@ module Aws::Kendra
|
|
2927
3124
|
# @return [Types::DataSourceVpcConfiguration]
|
2928
3125
|
#
|
2929
3126
|
# @!attribute [rw] created_at
|
2930
|
-
# The Unix timestamp
|
3127
|
+
# The Unix timestamp when the data source connector was created.
|
2931
3128
|
# @return [Time]
|
2932
3129
|
#
|
2933
3130
|
# @!attribute [rw] updated_at
|
2934
|
-
# The Unix timestamp
|
2935
|
-
# updated.
|
3131
|
+
# The Unix timestamp when the data source connector was last updated.
|
2936
3132
|
# @return [Time]
|
2937
3133
|
#
|
2938
3134
|
# @!attribute [rw] description
|
@@ -3053,11 +3249,12 @@ module Aws::Kendra
|
|
3053
3249
|
# @return [Types::ExperienceConfiguration]
|
3054
3250
|
#
|
3055
3251
|
# @!attribute [rw] created_at
|
3056
|
-
#
|
3252
|
+
# The Unix timestamp when your Amazon Kendra experience was created.
|
3057
3253
|
# @return [Time]
|
3058
3254
|
#
|
3059
3255
|
# @!attribute [rw] updated_at
|
3060
|
-
#
|
3256
|
+
# The Unix timestamp when your Amazon Kendra experience was last
|
3257
|
+
# updated.
|
3061
3258
|
# @return [Time]
|
3062
3259
|
#
|
3063
3260
|
# @!attribute [rw] description
|
@@ -3133,11 +3330,11 @@ module Aws::Kendra
|
|
3133
3330
|
# @return [String]
|
3134
3331
|
#
|
3135
3332
|
# @!attribute [rw] created_at
|
3136
|
-
# The
|
3333
|
+
# The Unix timestamp when the FAQ was created.
|
3137
3334
|
# @return [Time]
|
3138
3335
|
#
|
3139
3336
|
# @!attribute [rw] updated_at
|
3140
|
-
# The
|
3337
|
+
# The Unix timestamp when the FAQ was last updated.
|
3141
3338
|
# @return [Time]
|
3142
3339
|
#
|
3143
3340
|
# @!attribute [rw] s3_path
|
@@ -3193,6 +3390,105 @@ module Aws::Kendra
|
|
3193
3390
|
include Aws::Structure
|
3194
3391
|
end
|
3195
3392
|
|
3393
|
+
# @!attribute [rw] index_id
|
3394
|
+
# The identifier of the index used for featuring results.
|
3395
|
+
# @return [String]
|
3396
|
+
#
|
3397
|
+
# @!attribute [rw] featured_results_set_id
|
3398
|
+
# The identifier of the set of featured results that you want to get
|
3399
|
+
# information on.
|
3400
|
+
# @return [String]
|
3401
|
+
#
|
3402
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFeaturedResultsSetRequest AWS API Documentation
|
3403
|
+
#
|
3404
|
+
class DescribeFeaturedResultsSetRequest < Struct.new(
|
3405
|
+
:index_id,
|
3406
|
+
:featured_results_set_id)
|
3407
|
+
SENSITIVE = []
|
3408
|
+
include Aws::Structure
|
3409
|
+
end
|
3410
|
+
|
3411
|
+
# @!attribute [rw] featured_results_set_id
|
3412
|
+
# The identifier of the set of featured results.
|
3413
|
+
# @return [String]
|
3414
|
+
#
|
3415
|
+
# @!attribute [rw] featured_results_set_name
|
3416
|
+
# The name for the set of featured results.
|
3417
|
+
# @return [String]
|
3418
|
+
#
|
3419
|
+
# @!attribute [rw] description
|
3420
|
+
# The description for the set of featured results.
|
3421
|
+
# @return [String]
|
3422
|
+
#
|
3423
|
+
# @!attribute [rw] status
|
3424
|
+
# The current status of the set of featured results. When the value is
|
3425
|
+
# `ACTIVE`, featured results are ready for use. You can still
|
3426
|
+
# configure your settings before setting the status to `ACTIVE`. You
|
3427
|
+
# can set the status to `ACTIVE` or `INACTIVE` using the
|
3428
|
+
# [UpdateFeaturedResultsSet][1] API. The queries you specify for
|
3429
|
+
# featured results must be unique per featured results set for each
|
3430
|
+
# index, whether the status is `ACTIVE` or `INACTIVE`.
|
3431
|
+
#
|
3432
|
+
#
|
3433
|
+
#
|
3434
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html
|
3435
|
+
# @return [String]
|
3436
|
+
#
|
3437
|
+
# @!attribute [rw] query_texts
|
3438
|
+
# The list of queries for featuring results. For more information on
|
3439
|
+
# the list of queries, see [FeaturedResultsSet][1].
|
3440
|
+
#
|
3441
|
+
#
|
3442
|
+
#
|
3443
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html
|
3444
|
+
# @return [Array<String>]
|
3445
|
+
#
|
3446
|
+
# @!attribute [rw] featured_documents_with_metadata
|
3447
|
+
# The list of document IDs for the documents you want to feature with
|
3448
|
+
# their metadata information. For more information on the list of
|
3449
|
+
# featured documents, see [FeaturedResultsSet][1].
|
3450
|
+
#
|
3451
|
+
#
|
3452
|
+
#
|
3453
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html
|
3454
|
+
# @return [Array<Types::FeaturedDocumentWithMetadata>]
|
3455
|
+
#
|
3456
|
+
# @!attribute [rw] featured_documents_missing
|
3457
|
+
# The list of document IDs that don't exist but you have specified as
|
3458
|
+
# featured documents. Amazon Kendra cannot feature these documents if
|
3459
|
+
# they don't exist in the index. You can check the status of a
|
3460
|
+
# document and its ID or check for documents with status errors using
|
3461
|
+
# the [BatchGetDocumentStatus][1] API.
|
3462
|
+
#
|
3463
|
+
#
|
3464
|
+
#
|
3465
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchGetDocumentStatus.html
|
3466
|
+
# @return [Array<Types::FeaturedDocumentMissing>]
|
3467
|
+
#
|
3468
|
+
# @!attribute [rw] last_updated_timestamp
|
3469
|
+
# The timestamp when the set of featured results was last updated.
|
3470
|
+
# @return [Integer]
|
3471
|
+
#
|
3472
|
+
# @!attribute [rw] creation_timestamp
|
3473
|
+
# The Unix timestamp when the set of the featured results was created.
|
3474
|
+
# @return [Integer]
|
3475
|
+
#
|
3476
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFeaturedResultsSetResponse AWS API Documentation
|
3477
|
+
#
|
3478
|
+
class DescribeFeaturedResultsSetResponse < Struct.new(
|
3479
|
+
:featured_results_set_id,
|
3480
|
+
:featured_results_set_name,
|
3481
|
+
:description,
|
3482
|
+
:status,
|
3483
|
+
:query_texts,
|
3484
|
+
:featured_documents_with_metadata,
|
3485
|
+
:featured_documents_missing,
|
3486
|
+
:last_updated_timestamp,
|
3487
|
+
:creation_timestamp)
|
3488
|
+
SENSITIVE = []
|
3489
|
+
include Aws::Structure
|
3490
|
+
end
|
3491
|
+
|
3196
3492
|
# @!attribute [rw] id
|
3197
3493
|
# The identifier of the index you want to get information on.
|
3198
3494
|
# @return [String]
|
@@ -3239,11 +3535,11 @@ module Aws::Kendra
|
|
3239
3535
|
# @return [String]
|
3240
3536
|
#
|
3241
3537
|
# @!attribute [rw] created_at
|
3242
|
-
# The Unix
|
3538
|
+
# The Unix timestamp when the index was created.
|
3243
3539
|
# @return [Time]
|
3244
3540
|
#
|
3245
3541
|
# @!attribute [rw] updated_at
|
3246
|
-
# The Unix
|
3542
|
+
# The Unix when the index was last updated.
|
3247
3543
|
# @return [Time]
|
3248
3544
|
#
|
3249
3545
|
# @!attribute [rw] document_metadata_configurations
|
@@ -3360,17 +3656,17 @@ module Aws::Kendra
|
|
3360
3656
|
# Shows the following information on the processing of `PUT` and
|
3361
3657
|
# `DELETE` actions for mapping users to their groups:
|
3362
3658
|
#
|
3363
|
-
# * Status
|
3659
|
+
# * Status—the status can be either `PROCESSING`, `SUCCEEDED`,
|
3364
3660
|
# `DELETING`, `DELETED`, or `FAILED`.
|
3365
3661
|
#
|
3366
|
-
# * Last updated
|
3662
|
+
# * Last updated—the last date-time an action was updated.
|
3367
3663
|
#
|
3368
|
-
# * Received
|
3664
|
+
# * Received—the last date-time an action was received or submitted.
|
3369
3665
|
#
|
3370
|
-
# * Ordering ID
|
3371
|
-
#
|
3666
|
+
# * Ordering ID—the latest action that should process and apply after
|
3667
|
+
# other actions.
|
3372
3668
|
#
|
3373
|
-
# * Failure reason
|
3669
|
+
# * Failure reason—the reason an action could not be processed.
|
3374
3670
|
# @return [Array<Types::GroupOrderingIdSummary>]
|
3375
3671
|
#
|
3376
3672
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribePrincipalMappingResponse AWS API Documentation
|
@@ -3428,11 +3724,13 @@ module Aws::Kendra
|
|
3428
3724
|
# @return [String]
|
3429
3725
|
#
|
3430
3726
|
# @!attribute [rw] created_at
|
3431
|
-
# The
|
3727
|
+
# The Unix timestamp when a block list for query suggestions was
|
3728
|
+
# created.
|
3432
3729
|
# @return [Time]
|
3433
3730
|
#
|
3434
3731
|
# @!attribute [rw] updated_at
|
3435
|
-
# The
|
3732
|
+
# The Unix timestamp when a block list for query suggestions was last
|
3733
|
+
# updated.
|
3436
3734
|
# @return [Time]
|
3437
3735
|
#
|
3438
3736
|
# @!attribute [rw] source_s3_path
|
@@ -3541,11 +3839,13 @@ module Aws::Kendra
|
|
3541
3839
|
# @return [Integer]
|
3542
3840
|
#
|
3543
3841
|
# @!attribute [rw] last_suggestions_build_time
|
3544
|
-
# The
|
3842
|
+
# The Unix timestamp when query suggestions for an index was last
|
3843
|
+
# updated.
|
3545
3844
|
# @return [Time]
|
3546
3845
|
#
|
3547
3846
|
# @!attribute [rw] last_clear_time
|
3548
|
-
# The
|
3847
|
+
# The Unix timestamp when query suggestions for an index was last
|
3848
|
+
# cleared.
|
3549
3849
|
#
|
3550
3850
|
# After you clear suggestions, Amazon Kendra learns new suggestions
|
3551
3851
|
# based on new queries added to the query log from the time you
|
@@ -3627,11 +3927,11 @@ module Aws::Kendra
|
|
3627
3927
|
# @return [String]
|
3628
3928
|
#
|
3629
3929
|
# @!attribute [rw] created_at
|
3630
|
-
# The Unix
|
3930
|
+
# The Unix timestamp when the thesaurus was created.
|
3631
3931
|
# @return [Time]
|
3632
3932
|
#
|
3633
3933
|
# @!attribute [rw] updated_at
|
3634
|
-
# The Unix
|
3934
|
+
# The Unix timestamp when the thesaurus was last updated.
|
3635
3935
|
# @return [Time]
|
3636
3936
|
#
|
3637
3937
|
# @!attribute [rw] role_arn
|
@@ -4335,7 +4635,7 @@ module Aws::Kendra
|
|
4335
4635
|
# @return [String]
|
4336
4636
|
#
|
4337
4637
|
# @!attribute [rw] created_at
|
4338
|
-
# The
|
4638
|
+
# The Unix timestamp when your Amazon Kendra experience was created.
|
4339
4639
|
# @return [Time]
|
4340
4640
|
#
|
4341
4641
|
# @!attribute [rw] status
|
@@ -4504,11 +4804,11 @@ module Aws::Kendra
|
|
4504
4804
|
# @return [String]
|
4505
4805
|
#
|
4506
4806
|
# @!attribute [rw] created_at
|
4507
|
-
# The
|
4807
|
+
# The Unix timestamp when the FAQ was created.
|
4508
4808
|
# @return [Time]
|
4509
4809
|
#
|
4510
4810
|
# @!attribute [rw] updated_at
|
4511
|
-
# The
|
4811
|
+
# The Unix timestamp when the FAQ was last updated.
|
4512
4812
|
# @return [Time]
|
4513
4813
|
#
|
4514
4814
|
# @!attribute [rw] file_format
|
@@ -4541,6 +4841,319 @@ module Aws::Kendra
|
|
4541
4841
|
include Aws::Structure
|
4542
4842
|
end
|
4543
4843
|
|
4844
|
+
# A featured document. This document is displayed at the top of the
|
4845
|
+
# search results page, placed above all other results for certain
|
4846
|
+
# queries. If there's an exact match of a query, then the document is
|
4847
|
+
# featured in the search results.
|
4848
|
+
#
|
4849
|
+
# @!attribute [rw] id
|
4850
|
+
# The identifier of the document to feature in the search results. You
|
4851
|
+
# can use the [Query][1] API to search for specific documents with
|
4852
|
+
# their document IDs included in the result items, or you can use the
|
4853
|
+
# console.
|
4854
|
+
#
|
4855
|
+
#
|
4856
|
+
#
|
4857
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html
|
4858
|
+
# @return [String]
|
4859
|
+
#
|
4860
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FeaturedDocument AWS API Documentation
|
4861
|
+
#
|
4862
|
+
class FeaturedDocument < Struct.new(
|
4863
|
+
:id)
|
4864
|
+
SENSITIVE = []
|
4865
|
+
include Aws::Structure
|
4866
|
+
end
|
4867
|
+
|
4868
|
+
# A document ID doesn't exist but you have specified as a featured
|
4869
|
+
# document. Amazon Kendra cannot feature the document if it doesn't
|
4870
|
+
# exist in the index. You can check the status of a document and its ID
|
4871
|
+
# or check for documents with status errors using the
|
4872
|
+
# [BatchGetDocumentStatus][1] API.
|
4873
|
+
#
|
4874
|
+
#
|
4875
|
+
#
|
4876
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchGetDocumentStatus.html
|
4877
|
+
#
|
4878
|
+
# @!attribute [rw] id
|
4879
|
+
# The identifier of the document that doesn't exist but you have
|
4880
|
+
# specified as a featured document.
|
4881
|
+
# @return [String]
|
4882
|
+
#
|
4883
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FeaturedDocumentMissing AWS API Documentation
|
4884
|
+
#
|
4885
|
+
class FeaturedDocumentMissing < Struct.new(
|
4886
|
+
:id)
|
4887
|
+
SENSITIVE = []
|
4888
|
+
include Aws::Structure
|
4889
|
+
end
|
4890
|
+
|
4891
|
+
# A featured document with its metadata information. This document is
|
4892
|
+
# displayed at the top of the search results page, placed above all
|
4893
|
+
# other results for certain queries. If there's an exact match of a
|
4894
|
+
# query, then the document is featured in the search results.
|
4895
|
+
#
|
4896
|
+
# @!attribute [rw] id
|
4897
|
+
# The identifier of the featured document with its metadata. You can
|
4898
|
+
# use the [Query][1] API to search for specific documents with their
|
4899
|
+
# document IDs included in the result items, or you can use the
|
4900
|
+
# console.
|
4901
|
+
#
|
4902
|
+
#
|
4903
|
+
#
|
4904
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html
|
4905
|
+
# @return [String]
|
4906
|
+
#
|
4907
|
+
# @!attribute [rw] title
|
4908
|
+
# The main title of the featured document.
|
4909
|
+
# @return [String]
|
4910
|
+
#
|
4911
|
+
# @!attribute [rw] uri
|
4912
|
+
# The source URI location of the featured document.
|
4913
|
+
# @return [String]
|
4914
|
+
#
|
4915
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FeaturedDocumentWithMetadata AWS API Documentation
|
4916
|
+
#
|
4917
|
+
class FeaturedDocumentWithMetadata < Struct.new(
|
4918
|
+
:id,
|
4919
|
+
:title,
|
4920
|
+
:uri)
|
4921
|
+
SENSITIVE = []
|
4922
|
+
include Aws::Structure
|
4923
|
+
end
|
4924
|
+
|
4925
|
+
# An error message with a list of conflicting queries used across
|
4926
|
+
# different sets of featured results. This occurred with the request for
|
4927
|
+
# a new featured results set. Check that the queries you specified for
|
4928
|
+
# featured results are unique per featured results set for each index.
|
4929
|
+
#
|
4930
|
+
# @!attribute [rw] message
|
4931
|
+
# An explanation for the conflicting queries.
|
4932
|
+
# @return [String]
|
4933
|
+
#
|
4934
|
+
# @!attribute [rw] conflicting_items
|
4935
|
+
# A list of the conflicting queries, including the query text, the
|
4936
|
+
# name for the featured results set, and the identifier of the
|
4937
|
+
# featured results set.
|
4938
|
+
# @return [Array<Types::ConflictingItem>]
|
4939
|
+
#
|
4940
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FeaturedResultsConflictException AWS API Documentation
|
4941
|
+
#
|
4942
|
+
class FeaturedResultsConflictException < Struct.new(
|
4943
|
+
:message,
|
4944
|
+
:conflicting_items)
|
4945
|
+
SENSITIVE = []
|
4946
|
+
include Aws::Structure
|
4947
|
+
end
|
4948
|
+
|
4949
|
+
# A single featured result item. A featured result is displayed at the
|
4950
|
+
# top of the search results page, placed above all other results for
|
4951
|
+
# certain queries. If there's an exact match of a query, then certain
|
4952
|
+
# documents are featured in the search results.
|
4953
|
+
#
|
4954
|
+
# @!attribute [rw] id
|
4955
|
+
# The identifier of the featured result.
|
4956
|
+
# @return [String]
|
4957
|
+
#
|
4958
|
+
# @!attribute [rw] type
|
4959
|
+
# The type of document within the featured result response. For
|
4960
|
+
# example, a response could include a question-answer type that's
|
4961
|
+
# relevant to the query.
|
4962
|
+
# @return [String]
|
4963
|
+
#
|
4964
|
+
# @!attribute [rw] additional_attributes
|
4965
|
+
# One or more additional attributes associated with the featured
|
4966
|
+
# result.
|
4967
|
+
# @return [Array<Types::AdditionalResultAttribute>]
|
4968
|
+
#
|
4969
|
+
# @!attribute [rw] document_id
|
4970
|
+
# The identifier of the featured document.
|
4971
|
+
# @return [String]
|
4972
|
+
#
|
4973
|
+
# @!attribute [rw] document_title
|
4974
|
+
# Provides text and information about where to highlight the text.
|
4975
|
+
# @return [Types::TextWithHighlights]
|
4976
|
+
#
|
4977
|
+
# @!attribute [rw] document_excerpt
|
4978
|
+
# Provides text and information about where to highlight the text.
|
4979
|
+
# @return [Types::TextWithHighlights]
|
4980
|
+
#
|
4981
|
+
# @!attribute [rw] document_uri
|
4982
|
+
# The source URI location of the featured document.
|
4983
|
+
# @return [String]
|
4984
|
+
#
|
4985
|
+
# @!attribute [rw] document_attributes
|
4986
|
+
# An array of document attributes assigned to a featured document in
|
4987
|
+
# the search results. For example, the document author (`_author`) or
|
4988
|
+
# the source URI (`_source_uri`) of the document.
|
4989
|
+
# @return [Array<Types::DocumentAttribute>]
|
4990
|
+
#
|
4991
|
+
# @!attribute [rw] feedback_token
|
4992
|
+
# A token that identifies a particular featured result from a
|
4993
|
+
# particular query. Use this token to provide click-through feedback
|
4994
|
+
# for the result. For more information, see [Submitting feedback][1].
|
4995
|
+
#
|
4996
|
+
#
|
4997
|
+
#
|
4998
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/submitting-feedback.html
|
4999
|
+
# @return [String]
|
5000
|
+
#
|
5001
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FeaturedResultsItem AWS API Documentation
|
5002
|
+
#
|
5003
|
+
class FeaturedResultsItem < Struct.new(
|
5004
|
+
:id,
|
5005
|
+
:type,
|
5006
|
+
:additional_attributes,
|
5007
|
+
:document_id,
|
5008
|
+
:document_title,
|
5009
|
+
:document_excerpt,
|
5010
|
+
:document_uri,
|
5011
|
+
:document_attributes,
|
5012
|
+
:feedback_token)
|
5013
|
+
SENSITIVE = []
|
5014
|
+
include Aws::Structure
|
5015
|
+
end
|
5016
|
+
|
5017
|
+
# A set of featured results that are displayed at the top of your search
|
5018
|
+
# results. Featured results are placed above all other results for
|
5019
|
+
# certain queries. If there's an exact match of a query, then one or
|
5020
|
+
# more specific documents are featured in the search results.
|
5021
|
+
#
|
5022
|
+
# @!attribute [rw] featured_results_set_id
|
5023
|
+
# The identifier of the set of featured results.
|
5024
|
+
# @return [String]
|
5025
|
+
#
|
5026
|
+
# @!attribute [rw] featured_results_set_name
|
5027
|
+
# The name for the set of featured results.
|
5028
|
+
# @return [String]
|
5029
|
+
#
|
5030
|
+
# @!attribute [rw] description
|
5031
|
+
# The description for the set of featured results.
|
5032
|
+
# @return [String]
|
5033
|
+
#
|
5034
|
+
# @!attribute [rw] status
|
5035
|
+
# The current status of the set of featured results. When the value is
|
5036
|
+
# `ACTIVE`, featured results are ready for use. You can still
|
5037
|
+
# configure your settings before setting the status to `ACTIVE`. You
|
5038
|
+
# can set the status to `ACTIVE` or `INACTIVE` using the
|
5039
|
+
# [UpdateFeaturedResultsSet][1] API. The queries you specify for
|
5040
|
+
# featured results must be unique per featured results set for each
|
5041
|
+
# index, whether the status is `ACTIVE` or `INACTIVE`.
|
5042
|
+
#
|
5043
|
+
#
|
5044
|
+
#
|
5045
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html
|
5046
|
+
# @return [String]
|
5047
|
+
#
|
5048
|
+
# @!attribute [rw] query_texts
|
5049
|
+
# The list of queries for featuring results.
|
5050
|
+
#
|
5051
|
+
# Specific queries are mapped to specific documents for featuring in
|
5052
|
+
# the results. If a query contains an exact match, then one or more
|
5053
|
+
# specific documents are featured in the results. The exact match
|
5054
|
+
# applies to the full query. For example, if you only specify
|
5055
|
+
# 'Kendra', queries such as 'How does kendra semantically rank
|
5056
|
+
# results?' will not render the featured results. Featured results
|
5057
|
+
# are designed for specific queries, rather than queries that are too
|
5058
|
+
# broad in scope.
|
5059
|
+
# @return [Array<String>]
|
5060
|
+
#
|
5061
|
+
# @!attribute [rw] featured_documents
|
5062
|
+
# The list of document IDs for the documents you want to feature at
|
5063
|
+
# the top of the search results page. You can use the [Query][1] API
|
5064
|
+
# to search for specific documents with their document IDs included in
|
5065
|
+
# the result items, or you can use the console.
|
5066
|
+
#
|
5067
|
+
# You can add up to four featured documents. You can request to
|
5068
|
+
# increase this limit by contacting [Support][2].
|
5069
|
+
#
|
5070
|
+
# Specific queries are mapped to specific documents for featuring in
|
5071
|
+
# the results. If a query contains an exact match, then one or more
|
5072
|
+
# specific documents are featured in the results. The exact match
|
5073
|
+
# applies to the full query. For example, if you only specify
|
5074
|
+
# 'Kendra', queries such as 'How does kendra semantically rank
|
5075
|
+
# results?' will not render the featured results. Featured results
|
5076
|
+
# are designed for specific queries, rather than queries that are too
|
5077
|
+
# broad in scope.
|
5078
|
+
#
|
5079
|
+
#
|
5080
|
+
#
|
5081
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Query.html
|
5082
|
+
# [2]: http://aws.amazon.com/contact-us/
|
5083
|
+
# @return [Array<Types::FeaturedDocument>]
|
5084
|
+
#
|
5085
|
+
# @!attribute [rw] last_updated_timestamp
|
5086
|
+
# The Unix timestamp when the set of featured results was last
|
5087
|
+
# updated.
|
5088
|
+
# @return [Integer]
|
5089
|
+
#
|
5090
|
+
# @!attribute [rw] creation_timestamp
|
5091
|
+
# The Unix timestamp when the set of featured results was created.
|
5092
|
+
# @return [Integer]
|
5093
|
+
#
|
5094
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FeaturedResultsSet AWS API Documentation
|
5095
|
+
#
|
5096
|
+
class FeaturedResultsSet < Struct.new(
|
5097
|
+
:featured_results_set_id,
|
5098
|
+
:featured_results_set_name,
|
5099
|
+
:description,
|
5100
|
+
:status,
|
5101
|
+
:query_texts,
|
5102
|
+
:featured_documents,
|
5103
|
+
:last_updated_timestamp,
|
5104
|
+
:creation_timestamp)
|
5105
|
+
SENSITIVE = []
|
5106
|
+
include Aws::Structure
|
5107
|
+
end
|
5108
|
+
|
5109
|
+
# Summary information for a set of featured results. Featured results
|
5110
|
+
# are placed above all other results for certain queries. If there's an
|
5111
|
+
# exact match of a query, then one or more specific documents are
|
5112
|
+
# featured in the search results.
|
5113
|
+
#
|
5114
|
+
# @!attribute [rw] featured_results_set_id
|
5115
|
+
# The identifier of the set of featured results.
|
5116
|
+
# @return [String]
|
5117
|
+
#
|
5118
|
+
# @!attribute [rw] featured_results_set_name
|
5119
|
+
# The name for the set of featured results.
|
5120
|
+
# @return [String]
|
5121
|
+
#
|
5122
|
+
# @!attribute [rw] status
|
5123
|
+
# The current status of the set of featured results. When the value is
|
5124
|
+
# `ACTIVE`, featured results are ready for use. You can still
|
5125
|
+
# configure your settings before setting the status to `ACTIVE`. You
|
5126
|
+
# can set the status to `ACTIVE` or `INACTIVE` using the
|
5127
|
+
# [UpdateFeaturedResultsSet][1] API. The queries you specify for
|
5128
|
+
# featured results must be unique per featured results set for each
|
5129
|
+
# index, whether the status is `ACTIVE` or `INACTIVE`.
|
5130
|
+
#
|
5131
|
+
#
|
5132
|
+
#
|
5133
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html
|
5134
|
+
# @return [String]
|
5135
|
+
#
|
5136
|
+
# @!attribute [rw] last_updated_timestamp
|
5137
|
+
# The Unix timestamp when the set of featured results was last
|
5138
|
+
# updated.
|
5139
|
+
# @return [Integer]
|
5140
|
+
#
|
5141
|
+
# @!attribute [rw] creation_timestamp
|
5142
|
+
# The Unix timestamp when the set of featured results was created.
|
5143
|
+
# @return [Integer]
|
5144
|
+
#
|
5145
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FeaturedResultsSetSummary AWS API Documentation
|
5146
|
+
#
|
5147
|
+
class FeaturedResultsSetSummary < Struct.new(
|
5148
|
+
:featured_results_set_id,
|
5149
|
+
:featured_results_set_name,
|
5150
|
+
:status,
|
5151
|
+
:last_updated_timestamp,
|
5152
|
+
:creation_timestamp)
|
5153
|
+
SENSITIVE = []
|
5154
|
+
include Aws::Structure
|
5155
|
+
end
|
5156
|
+
|
4544
5157
|
# Provides the configuration information to connect to Amazon FSx as
|
4545
5158
|
# your data source.
|
4546
5159
|
#
|
@@ -4686,23 +5299,23 @@ module Aws::Kendra
|
|
4686
5299
|
# time interval uses the time zone of your index. You can view data in
|
4687
5300
|
# the following time windows:
|
4688
5301
|
#
|
4689
|
-
# * `THIS_WEEK
|
5302
|
+
# * `THIS_WEEK`: The current week, starting on the Sunday and ending
|
4690
5303
|
# on the day before the current date.
|
4691
5304
|
#
|
4692
|
-
# * `ONE_WEEK_AGO
|
5305
|
+
# * `ONE_WEEK_AGO`: The previous week, starting on the Sunday and
|
4693
5306
|
# ending on the following Saturday.
|
4694
5307
|
#
|
4695
|
-
# * `TWO_WEEKS_AGO
|
5308
|
+
# * `TWO_WEEKS_AGO`: The week before the previous week, starting on
|
4696
5309
|
# the Sunday and ending on the following Saturday.
|
4697
5310
|
#
|
4698
|
-
# * `THIS_MONTH
|
5311
|
+
# * `THIS_MONTH`: The current month, starting on the first day of the
|
4699
5312
|
# month and ending on the day before the current date.
|
4700
5313
|
#
|
4701
|
-
# * `ONE_MONTH_AGO
|
5314
|
+
# * `ONE_MONTH_AGO`: The previous month, starting on the first day of
|
4702
5315
|
# the month and ending on the last day of the month.
|
4703
5316
|
#
|
4704
|
-
# * `TWO_MONTHS_AGO
|
4705
|
-
#
|
5317
|
+
# * `TWO_MONTHS_AGO`: The month before the previous month, starting on
|
5318
|
+
# the first day of the month and ending on last day of the month.
|
4706
5319
|
# @return [String]
|
4707
5320
|
#
|
4708
5321
|
# @!attribute [rw] metric_type
|
@@ -4741,8 +5354,8 @@ module Aws::Kendra
|
|
4741
5354
|
end
|
4742
5355
|
|
4743
5356
|
# @!attribute [rw] snap_shot_time_filter
|
4744
|
-
# The
|
4745
|
-
# search metrics data.
|
5357
|
+
# The Unix timestamp for the beginning and end of the time window for
|
5358
|
+
# the search metrics data.
|
4746
5359
|
# @return [Types::TimeRange]
|
4747
5360
|
#
|
4748
5361
|
# @!attribute [rw] snapshots_data_header
|
@@ -5202,13 +5815,14 @@ module Aws::Kendra
|
|
5202
5815
|
# @return [String]
|
5203
5816
|
#
|
5204
5817
|
# @!attribute [rw] last_updated_at
|
5205
|
-
# The
|
5206
|
-
# or `DELETE` action for mapping users to their groups.
|
5818
|
+
# The Unix timestamp when an action was last updated. An action can be
|
5819
|
+
# a `PUT` or `DELETE` action for mapping users to their groups.
|
5207
5820
|
# @return [Time]
|
5208
5821
|
#
|
5209
5822
|
# @!attribute [rw] received_at
|
5210
|
-
# The
|
5211
|
-
# be a `PUT` or `DELETE` action for mapping users to their
|
5823
|
+
# The Unix timestamp when an action was received by Amazon Kendra. An
|
5824
|
+
# action can be a `PUT` or `DELETE` action for mapping users to their
|
5825
|
+
# groups.
|
5212
5826
|
# @return [Time]
|
5213
5827
|
#
|
5214
5828
|
# @!attribute [rw] ordering_id
|
@@ -5387,8 +6001,7 @@ module Aws::Kendra
|
|
5387
6001
|
# @return [Time]
|
5388
6002
|
#
|
5389
6003
|
# @!attribute [rw] updated_at
|
5390
|
-
# The Unix timestamp when the index was last updated
|
5391
|
-
# `UpdateIndex` API.
|
6004
|
+
# The Unix timestamp when the index was last updated.
|
5392
6005
|
# @return [Time]
|
5393
6006
|
#
|
5394
6007
|
# @!attribute [rw] status
|
@@ -5470,12 +6083,12 @@ module Aws::Kendra
|
|
5470
6083
|
end
|
5471
6084
|
|
5472
6085
|
# An issue occurred with the internal server used for your Amazon Kendra
|
5473
|
-
# service. Please wait a few minutes and try again, or contact
|
5474
|
-
# Support][1] for help.
|
6086
|
+
# service. Please wait a few minutes and try again, or contact
|
6087
|
+
# [Support][1] for help.
|
5475
6088
|
#
|
5476
6089
|
#
|
5477
6090
|
#
|
5478
|
-
# [1]: http://aws.amazon.com/
|
6091
|
+
# [1]: http://aws.amazon.com/contact-us/
|
5479
6092
|
#
|
5480
6093
|
# @!attribute [rw] message
|
5481
6094
|
# @return [String]
|
@@ -6067,6 +6680,49 @@ module Aws::Kendra
|
|
6067
6680
|
include Aws::Structure
|
6068
6681
|
end
|
6069
6682
|
|
6683
|
+
# @!attribute [rw] index_id
|
6684
|
+
# The identifier of the index used for featuring results.
|
6685
|
+
# @return [String]
|
6686
|
+
#
|
6687
|
+
# @!attribute [rw] next_token
|
6688
|
+
# If the response is truncated, Amazon Kendra returns a pagination
|
6689
|
+
# token in the response. You can use this pagination token to retrieve
|
6690
|
+
# the next set of featured results sets.
|
6691
|
+
# @return [String]
|
6692
|
+
#
|
6693
|
+
# @!attribute [rw] max_results
|
6694
|
+
# The maximum number of featured results sets to return.
|
6695
|
+
# @return [Integer]
|
6696
|
+
#
|
6697
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFeaturedResultsSetsRequest AWS API Documentation
|
6698
|
+
#
|
6699
|
+
class ListFeaturedResultsSetsRequest < Struct.new(
|
6700
|
+
:index_id,
|
6701
|
+
:next_token,
|
6702
|
+
:max_results)
|
6703
|
+
SENSITIVE = []
|
6704
|
+
include Aws::Structure
|
6705
|
+
end
|
6706
|
+
|
6707
|
+
# @!attribute [rw] featured_results_set_summary_items
|
6708
|
+
# An array of summary information for one or more featured results
|
6709
|
+
# sets.
|
6710
|
+
# @return [Array<Types::FeaturedResultsSetSummary>]
|
6711
|
+
#
|
6712
|
+
# @!attribute [rw] next_token
|
6713
|
+
# If the response is truncated, Amazon Kendra returns a pagination
|
6714
|
+
# token in the response.
|
6715
|
+
# @return [String]
|
6716
|
+
#
|
6717
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFeaturedResultsSetsResponse AWS API Documentation
|
6718
|
+
#
|
6719
|
+
class ListFeaturedResultsSetsResponse < Struct.new(
|
6720
|
+
:featured_results_set_summary_items,
|
6721
|
+
:next_token)
|
6722
|
+
SENSITIVE = []
|
6723
|
+
include Aws::Structure
|
6724
|
+
end
|
6725
|
+
|
6070
6726
|
# @!attribute [rw] index_id
|
6071
6727
|
# The identifier of the index for getting a list of groups mapped to
|
6072
6728
|
# users before a given ordering or timestamp identifier.
|
@@ -6499,11 +7155,11 @@ module Aws::Kendra
|
|
6499
7155
|
# @return [String]
|
6500
7156
|
#
|
6501
7157
|
# @!attribute [rw] created_at
|
6502
|
-
# The
|
7158
|
+
# The Unix timestamp when the summary information was created.
|
6503
7159
|
# @return [Time]
|
6504
7160
|
#
|
6505
7161
|
# @!attribute [rw] updated_at
|
6506
|
-
# The
|
7162
|
+
# The Unix timestamp when the summary information was last updated.
|
6507
7163
|
# @return [Time]
|
6508
7164
|
#
|
6509
7165
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/PersonasSummary AWS API Documentation
|
@@ -6637,14 +7293,14 @@ module Aws::Kendra
|
|
6637
7293
|
# number IDs. This prevents previous actions with lower number IDs
|
6638
7294
|
# from possibly overriding the latest action.
|
6639
7295
|
#
|
6640
|
-
# The ordering ID can be the
|
7296
|
+
# The ordering ID can be the Unix time of the last update you made to
|
6641
7297
|
# a group members list. You would then provide this list when calling
|
6642
7298
|
# `PutPrincipalMapping`. This ensures your `PUT` action for that
|
6643
7299
|
# updated group with the latest members list doesn't get overwritten
|
6644
7300
|
# by earlier `PUT` actions for the same group which are yet to be
|
6645
7301
|
# processed.
|
6646
7302
|
#
|
6647
|
-
# The default ordering ID is the current
|
7303
|
+
# The default ordering ID is the current Unix time in milliseconds
|
6648
7304
|
# that the action was received by Amazon Kendra.
|
6649
7305
|
# @return [Integer]
|
6650
7306
|
#
|
@@ -6830,6 +7486,13 @@ module Aws::Kendra
|
|
6830
7486
|
# query.
|
6831
7487
|
# @return [Array<Types::SpellCorrectedQuery>]
|
6832
7488
|
#
|
7489
|
+
# @!attribute [rw] featured_results_items
|
7490
|
+
# The list of featured result items. Featured results are displayed at
|
7491
|
+
# the top of the search results page, placed above all other results
|
7492
|
+
# for certain queries. If there's an exact match of a query, then
|
7493
|
+
# certain documents are featured in the search results.
|
7494
|
+
# @return [Array<Types::FeaturedResultsItem>]
|
7495
|
+
#
|
6833
7496
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResult AWS API Documentation
|
6834
7497
|
#
|
6835
7498
|
class QueryResult < Struct.new(
|
@@ -6838,7 +7501,8 @@ module Aws::Kendra
|
|
6838
7501
|
:facet_results,
|
6839
7502
|
:total_number_of_results,
|
6840
7503
|
:warnings,
|
6841
|
-
:spell_corrected_queries
|
7504
|
+
:spell_corrected_queries,
|
7505
|
+
:featured_results_items)
|
6842
7506
|
SENSITIVE = []
|
6843
7507
|
include Aws::Structure
|
6844
7508
|
end
|
@@ -6965,12 +7629,11 @@ module Aws::Kendra
|
|
6965
7629
|
# @return [String]
|
6966
7630
|
#
|
6967
7631
|
# @!attribute [rw] created_at
|
6968
|
-
# The
|
6969
|
-
# was last created.
|
7632
|
+
# The Unix timestamp when the block list was created.
|
6970
7633
|
# @return [Time]
|
6971
7634
|
#
|
6972
7635
|
# @!attribute [rw] updated_at
|
6973
|
-
# The
|
7636
|
+
# The Unix timestamp when the block list was last updated.
|
6974
7637
|
# @return [Time]
|
6975
7638
|
#
|
6976
7639
|
# @!attribute [rw] item_count
|
@@ -7201,7 +7864,7 @@ module Aws::Kendra
|
|
7201
7864
|
# @return [String]
|
7202
7865
|
#
|
7203
7866
|
# @!attribute [rw] relevance_value
|
7204
|
-
# Whether
|
7867
|
+
# Whether the document was relevant or not relevant to the search.
|
7205
7868
|
# @return [String]
|
7206
7869
|
#
|
7207
7870
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/RelevanceFeedback AWS API Documentation
|
@@ -7461,8 +8124,8 @@ module Aws::Kendra
|
|
7461
8124
|
# * password - The password associated with the user logging in to the
|
7462
8125
|
# Salesforce instance.
|
7463
8126
|
#
|
7464
|
-
# * securityToken - The token associated with the user
|
7465
|
-
#
|
8127
|
+
# * securityToken - The token associated with the user logging in to
|
8128
|
+
# the Salesforce instance.
|
7466
8129
|
#
|
7467
8130
|
# * username - The user name of the user logging in to the Salesforce
|
7468
8131
|
# instance.
|
@@ -7759,8 +8422,8 @@ module Aws::Kendra
|
|
7759
8422
|
#
|
7760
8423
|
# *When selecting websites to index, you must adhere to the [Amazon
|
7761
8424
|
# Acceptable Use Policy][1] and all other Amazon terms. Remember that
|
7762
|
-
# you must only use Amazon Kendra Web Crawler to index your own
|
7763
|
-
#
|
8425
|
+
# you must only use Amazon Kendra Web Crawler to index your own web
|
8426
|
+
# pages, or web pages that you have authorization to index.*
|
7764
8427
|
#
|
7765
8428
|
#
|
7766
8429
|
#
|
@@ -7785,7 +8448,7 @@ module Aws::Kendra
|
|
7785
8448
|
# "a.abc.example.com" and "b.abc.example.com" are also crawled.
|
7786
8449
|
#
|
7787
8450
|
# * `EVERYTHING` – crawl the website host names with subdomains and
|
7788
|
-
# other domains that the
|
8451
|
+
# other domains that the web pages link to.
|
7789
8452
|
#
|
7790
8453
|
# The default mode is set to `HOST_ONLY`.
|
7791
8454
|
# @return [String]
|
@@ -8028,12 +8691,13 @@ module Aws::Kendra
|
|
8028
8691
|
end
|
8029
8692
|
|
8030
8693
|
# You have exceeded the set limits for your Amazon Kendra service.
|
8031
|
-
# Please see
|
8032
|
-
#
|
8694
|
+
# Please see [Quotas][1] for more information, or contact [Support][2]
|
8695
|
+
# to inquire about an increase of limits.
|
8033
8696
|
#
|
8034
8697
|
#
|
8035
8698
|
#
|
8036
|
-
# [1]:
|
8699
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
|
8700
|
+
# [2]: http://aws.amazon.com/contact-us/
|
8037
8701
|
#
|
8038
8702
|
# @!attribute [rw] message
|
8039
8703
|
# @return [String]
|
@@ -8061,13 +8725,8 @@ module Aws::Kendra
|
|
8061
8725
|
# @!attribute [rw] secret_arn
|
8062
8726
|
# The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
8063
8727
|
# contains the user name and password required to connect to the
|
8064
|
-
# SharePoint instance.
|
8065
|
-
#
|
8066
|
-
# information, see [Using a Microsoft SharePoint Data Source][1].
|
8067
|
-
#
|
8068
|
-
# You can also provide OAuth authentication credentials of user name,
|
8069
|
-
# password, client ID, and client secret. For more information, see
|
8070
|
-
# [Using a SharePoint data source][1].
|
8728
|
+
# SharePoint instance. For more information, see [Microsoft
|
8729
|
+
# SharePoint][1].
|
8071
8730
|
#
|
8072
8731
|
#
|
8073
8732
|
#
|
@@ -8144,9 +8803,9 @@ module Aws::Kendra
|
|
8144
8803
|
# use this to connect to SharePoint Server if you require a secure SSL
|
8145
8804
|
# connection.
|
8146
8805
|
#
|
8147
|
-
# You can
|
8148
|
-
#
|
8149
|
-
#
|
8806
|
+
# You can generate a self-signed X509 certificate on any computer
|
8807
|
+
# using OpenSSL. For an example of using OpenSSL to create an X509
|
8808
|
+
# certificate, see [Create and sign an X509 certificate][1].
|
8150
8809
|
#
|
8151
8810
|
#
|
8152
8811
|
#
|
@@ -8154,10 +8813,10 @@ module Aws::Kendra
|
|
8154
8813
|
# @return [Types::S3Path]
|
8155
8814
|
#
|
8156
8815
|
# @!attribute [rw] authentication_type
|
8157
|
-
# Whether you want to connect to SharePoint using basic
|
8158
|
-
# of user name and password, or OAuth authentication of
|
8159
|
-
# password, client ID, and client secret
|
8160
|
-
# authentication
|
8816
|
+
# Whether you want to connect to SharePoint Online using basic
|
8817
|
+
# authentication of user name and password, or OAuth authentication of
|
8818
|
+
# user name, password, client ID, and client secret, or AD App-only
|
8819
|
+
# authentication of client secret.
|
8161
8820
|
# @return [String]
|
8162
8821
|
#
|
8163
8822
|
# @!attribute [rw] proxy_configuration
|
@@ -8208,8 +8867,8 @@ module Aws::Kendra
|
|
8208
8867
|
#
|
8209
8868
|
# *When selecting websites to index, you must adhere to the [Amazon
|
8210
8869
|
# Acceptable Use Policy][1] and all other Amazon terms. Remember that
|
8211
|
-
# you must only use Amazon Kendra Web Crawler to index your own
|
8212
|
-
#
|
8870
|
+
# you must only use Amazon Kendra Web Crawler to index your own web
|
8871
|
+
# pages, or web pages that you have authorization to index.*
|
8213
8872
|
#
|
8214
8873
|
#
|
8215
8874
|
#
|
@@ -8886,11 +9545,11 @@ module Aws::Kendra
|
|
8886
9545
|
# @return [String]
|
8887
9546
|
#
|
8888
9547
|
# @!attribute [rw] created_at
|
8889
|
-
# The Unix
|
9548
|
+
# The Unix timestamp when the thesaurus was created.
|
8890
9549
|
# @return [Time]
|
8891
9550
|
#
|
8892
9551
|
# @!attribute [rw] updated_at
|
8893
|
-
# The Unix
|
9552
|
+
# The Unix timestamp when the thesaurus was last updated.
|
8894
9553
|
# @return [Time]
|
8895
9554
|
#
|
8896
9555
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ThesaurusSummary AWS API Documentation
|
@@ -8922,11 +9581,11 @@ module Aws::Kendra
|
|
8922
9581
|
# Provides a range of time.
|
8923
9582
|
#
|
8924
9583
|
# @!attribute [rw] start_time
|
8925
|
-
# The
|
9584
|
+
# The Unix timestamp for the beginning of the time range.
|
8926
9585
|
# @return [Time]
|
8927
9586
|
#
|
8928
9587
|
# @!attribute [rw] end_time
|
8929
|
-
# The
|
9588
|
+
# The Unix timestamp for the end of the time range.
|
8930
9589
|
# @return [Time]
|
8931
9590
|
#
|
8932
9591
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TimeRange AWS API Documentation
|
@@ -9144,6 +9803,79 @@ module Aws::Kendra
|
|
9144
9803
|
include Aws::Structure
|
9145
9804
|
end
|
9146
9805
|
|
9806
|
+
# @!attribute [rw] index_id
|
9807
|
+
# The identifier of the index used for featuring results.
|
9808
|
+
# @return [String]
|
9809
|
+
#
|
9810
|
+
# @!attribute [rw] featured_results_set_id
|
9811
|
+
# The identifier of the index used for featuring results.
|
9812
|
+
# @return [String]
|
9813
|
+
#
|
9814
|
+
# @!attribute [rw] featured_results_set_name
|
9815
|
+
# A new name for the set of featured results.
|
9816
|
+
# @return [String]
|
9817
|
+
#
|
9818
|
+
# @!attribute [rw] description
|
9819
|
+
# A new description for the set of featured results.
|
9820
|
+
# @return [String]
|
9821
|
+
#
|
9822
|
+
# @!attribute [rw] status
|
9823
|
+
# You can set the status to `ACTIVE` or `INACTIVE`. When the value is
|
9824
|
+
# `ACTIVE`, featured results are ready for use. You can still
|
9825
|
+
# configure your settings before setting the status to `ACTIVE`. The
|
9826
|
+
# queries you specify for featured results must be unique per featured
|
9827
|
+
# results set for each index, whether the status is `ACTIVE` or
|
9828
|
+
# `INACTIVE`.
|
9829
|
+
# @return [String]
|
9830
|
+
#
|
9831
|
+
# @!attribute [rw] query_texts
|
9832
|
+
# A list of queries for featuring results. For more information on the
|
9833
|
+
# list of queries, see [FeaturedResultsSet][1].
|
9834
|
+
#
|
9835
|
+
#
|
9836
|
+
#
|
9837
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html
|
9838
|
+
# @return [Array<String>]
|
9839
|
+
#
|
9840
|
+
# @!attribute [rw] featured_documents
|
9841
|
+
# A list of document IDs for the documents you want to feature at the
|
9842
|
+
# top of the search results page. For more information on the list of
|
9843
|
+
# featured documents, see [FeaturedResultsSet][1].
|
9844
|
+
#
|
9845
|
+
#
|
9846
|
+
#
|
9847
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html
|
9848
|
+
# @return [Array<Types::FeaturedDocument>]
|
9849
|
+
#
|
9850
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateFeaturedResultsSetRequest AWS API Documentation
|
9851
|
+
#
|
9852
|
+
class UpdateFeaturedResultsSetRequest < Struct.new(
|
9853
|
+
:index_id,
|
9854
|
+
:featured_results_set_id,
|
9855
|
+
:featured_results_set_name,
|
9856
|
+
:description,
|
9857
|
+
:status,
|
9858
|
+
:query_texts,
|
9859
|
+
:featured_documents)
|
9860
|
+
SENSITIVE = []
|
9861
|
+
include Aws::Structure
|
9862
|
+
end
|
9863
|
+
|
9864
|
+
# @!attribute [rw] featured_results_set
|
9865
|
+
# Information on the set of featured results. This includes the
|
9866
|
+
# identifier of the featured results set, whether the featured results
|
9867
|
+
# set is active or inactive, when the featured results set was last
|
9868
|
+
# updated, and more.
|
9869
|
+
# @return [Types::FeaturedResultsSet]
|
9870
|
+
#
|
9871
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateFeaturedResultsSetResponse AWS API Documentation
|
9872
|
+
#
|
9873
|
+
class UpdateFeaturedResultsSetResponse < Struct.new(
|
9874
|
+
:featured_results_set)
|
9875
|
+
SENSITIVE = []
|
9876
|
+
include Aws::Structure
|
9877
|
+
end
|
9878
|
+
|
9147
9879
|
# @!attribute [rw] id
|
9148
9880
|
# The identifier of the index you want to update.
|
9149
9881
|
# @return [String]
|
@@ -9384,8 +10116,8 @@ module Aws::Kendra
|
|
9384
10116
|
#
|
9385
10117
|
# *When selecting websites to index, you must adhere to the [Amazon
|
9386
10118
|
# Acceptable Use Policy][1] and all other Amazon terms. Remember that
|
9387
|
-
# you must only use Amazon Kendra Web Crawler to index your own
|
9388
|
-
#
|
10119
|
+
# you must only use Amazon Kendra Web Crawler to index your own web
|
10120
|
+
# pages, or web pages that you have authorization to index.*
|
9389
10121
|
#
|
9390
10122
|
#
|
9391
10123
|
#
|
@@ -9397,7 +10129,7 @@ module Aws::Kendra
|
|
9397
10129
|
#
|
9398
10130
|
# You can choose to crawl only the website host names, or the website
|
9399
10131
|
# host names with subdomains, or the website host names with
|
9400
|
-
# subdomains and other domains that the
|
10132
|
+
# subdomains and other domains that the web pages link to.
|
9401
10133
|
#
|
9402
10134
|
# You can list up to 100 seed URLs.
|
9403
10135
|
# @return [Types::SeedUrlConfiguration]
|
@@ -9469,13 +10201,12 @@ module Aws::Kendra
|
|
9469
10201
|
include Aws::Structure
|
9470
10202
|
end
|
9471
10203
|
|
9472
|
-
# Provides the configuration information to
|
9473
|
-
#
|
9474
|
-
#
|
9475
|
-
#
|
9476
|
-
#
|
9477
|
-
#
|
9478
|
-
# ID when you issue the query.
|
10204
|
+
# Provides the configuration information to get users and groups from an
|
10205
|
+
# IAM Identity Center (successor to Single Sign-On) identity source.
|
10206
|
+
# This is useful for user context filtering, where search results are
|
10207
|
+
# filtered based on the user or their group access to documents. You can
|
10208
|
+
# also use the [PutPrincipalMapping][1] API to map users to their groups
|
10209
|
+
# so that you only need to provide the user ID when you issue the query.
|
9479
10210
|
#
|
9480
10211
|
# To set up an IAM Identity Center identity source in the console to use
|
9481
10212
|
# with Amazon Kendra, see [Getting started with an IAM Identity Center
|
@@ -9496,11 +10227,10 @@ module Aws::Kendra
|
|
9496
10227
|
# [3]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-aws-sso
|
9497
10228
|
#
|
9498
10229
|
# @!attribute [rw] user_group_resolution_mode
|
9499
|
-
# The identity store provider (mode) you want to use to
|
9500
|
-
#
|
9501
|
-
#
|
9502
|
-
#
|
9503
|
-
# this mode.
|
10230
|
+
# The identity store provider (mode) you want to use to get users and
|
10231
|
+
# groups. IAM Identity Center (successor to Single Sign-On) is
|
10232
|
+
# currently the only available mode. Your users and groups must exist
|
10233
|
+
# in an IAM Identity Center identity source in order to use this mode.
|
9504
10234
|
# @return [String]
|
9505
10235
|
#
|
9506
10236
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UserGroupResolutionConfiguration AWS API Documentation
|
@@ -9606,8 +10336,8 @@ module Aws::Kendra
|
|
9606
10336
|
#
|
9607
10337
|
# *When selecting websites to index, you must adhere to the [Amazon
|
9608
10338
|
# Acceptable Use Policy][1] and all other Amazon terms. Remember that
|
9609
|
-
# you must only use Amazon Kendra Web Crawler to index your own
|
9610
|
-
#
|
10339
|
+
# you must only use Amazon Kendra Web Crawler to index your own web
|
10340
|
+
# pages, or web pages that you have authorization to index.*
|
9611
10341
|
#
|
9612
10342
|
#
|
9613
10343
|
#
|
@@ -9618,31 +10348,32 @@ module Aws::Kendra
|
|
9618
10348
|
# Specifies the number of levels in a website that you want to crawl.
|
9619
10349
|
#
|
9620
10350
|
# The first level begins from the website seed or starting point URL.
|
9621
|
-
# For example, if a website has
|
9622
|
-
# this example), sections level, and subsections level
|
10351
|
+
# For example, if a website has three levels—index level (the seed in
|
10352
|
+
# this example), sections level, and subsections level—and you are
|
9623
10353
|
# only interested in crawling information up to the sections level
|
9624
|
-
# (
|
10354
|
+
# (levels 0-1), you can set your depth to 1.
|
9625
10355
|
#
|
9626
10356
|
# The default crawl depth is set to 2.
|
9627
10357
|
# @return [Integer]
|
9628
10358
|
#
|
9629
10359
|
# @!attribute [rw] max_links_per_page
|
9630
|
-
# The maximum number of URLs on a
|
9631
|
-
# website. This number is per
|
10360
|
+
# The maximum number of URLs on a web page to include when crawling a
|
10361
|
+
# website. This number is per web page.
|
9632
10362
|
#
|
9633
|
-
# As a website’s
|
9634
|
-
# are also crawled. URLs on a
|
10363
|
+
# As a website’s web pages are crawled, any URLs the web pages link to
|
10364
|
+
# are also crawled. URLs on a web page are crawled in order of
|
9635
10365
|
# appearance.
|
9636
10366
|
#
|
9637
10367
|
# The default maximum links per page is 100.
|
9638
10368
|
# @return [Integer]
|
9639
10369
|
#
|
9640
10370
|
# @!attribute [rw] max_content_size_per_page_in_mega_bytes
|
9641
|
-
# The maximum size (in MB) of a
|
10371
|
+
# The maximum size (in MB) of a web page or attachment to crawl.
|
9642
10372
|
#
|
9643
10373
|
# Files larger than this size (in MB) are skipped/not crawled.
|
9644
10374
|
#
|
9645
|
-
# The default maximum size of a
|
10375
|
+
# The default maximum size of a web page or attachment is set to 50
|
10376
|
+
# MB.
|
9646
10377
|
# @return [Float]
|
9647
10378
|
#
|
9648
10379
|
# @!attribute [rw] max_urls_per_minute_crawl_rate
|