aws-sdk-kendra 1.7.1 → 1.12.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 529b08466475f295428bc9fb53752bc008d538d641b56b97389a3f04cd4d6379
4
- data.tar.gz: 2e2926eff5de34b3bff834b0daf77ffac50f083fe14f7a9057d6e7385f253a8c
3
+ metadata.gz: 7a9340f9b575e1efc6e3d58759637f4ddcc529389bd64ef64ccec69c115795e1
4
+ data.tar.gz: 8177a2f4e120c2d52a86b252c523f6e8ad97f4d606ef77c45a3106f2f064246c
5
5
  SHA512:
6
- metadata.gz: 942f055cdb21898759db3c7b3a6c16b95c421cc67f7043f27c4543e6fb32c63fb8cd6b65b6a4f4c67032259104cc65fd29a29ec70aa0462db90a7bd89848d69d
7
- data.tar.gz: 6cf3f9e590a9f330d5a8c9001ccc94ab51f1de2a0b583910e61d1b30a18e975b7e32d7c658fc34e686ca4147fc713377552490798f62d883b747a26da4bdbcb0
6
+ metadata.gz: 54d1dcc6305d664fd10c0b38782228da0bc2b4af9d5a459566a0a41af5d4aa22be2afade268eee65ae5e04f72f79de83e4ca6e6cb58000cc75894e767e3d5c47
7
+ data.tar.gz: 0aeb02d338908d92fd4f683b6639ffc5585ed3cf96580a8c2504756b317f867856ef1a209c02f3e268f9f6e45f70902391111f7bfed9a45955cf2a830c42b953
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -5,6 +7,7 @@
5
7
  #
6
8
  # WARNING ABOUT GENERATED CODE
7
9
 
10
+
8
11
  require 'aws-sdk-core'
9
12
  require 'aws-sigv4'
10
13
 
@@ -42,9 +45,9 @@ require_relative 'aws-sdk-kendra/customizations'
42
45
  #
43
46
  # See {Errors} for more information.
44
47
  #
45
- # @service
48
+ # @!group service
46
49
  module Aws::Kendra
47
50
 
48
- GEM_VERSION = '1.7.1'
51
+ GEM_VERSION = '1.12.0'
49
52
 
50
53
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -83,13 +85,28 @@ module Aws::Kendra
83
85
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
84
86
  # credentials.
85
87
  #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
86
102
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
87
103
  # from an EC2 IMDS on an EC2 instance.
88
104
  #
89
- # * `Aws::SharedCredentials` - Used for loading credentials from a
90
- # shared file, such as `~/.aws/config`.
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
91
107
  #
92
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
93
110
  #
94
111
  # When `:credentials` are not configured directly, the following
95
112
  # locations will be searched for credentials:
@@ -99,10 +116,10 @@ module Aws::Kendra
99
116
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
100
117
  # * `~/.aws/credentials`
101
118
  # * `~/.aws/config`
102
- # * EC2 IMDS instance profile - When used by default, the timeouts are
103
- # very aggressive. Construct and pass an instance of
104
- # `Aws::InstanceProfileCredentails` to enable retries and extended
105
- # timeouts.
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
106
123
  #
107
124
  # @option options [required, String] :region
108
125
  # The AWS region to connect to. The configured `:region` is
@@ -590,6 +607,9 @@ module Aws::Kendra
590
607
  # acl_configuration: {
591
608
  # allowed_groups_column_name: "ColumnName", # required
592
609
  # },
610
+ # sql_configuration: {
611
+ # query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
612
+ # },
593
613
  # },
594
614
  # salesforce_configuration: {
595
615
  # server_url: "Url", # required
@@ -823,6 +843,9 @@ module Aws::Kendra
823
843
  # databases. Once you set the edition for an index, it can't be
824
844
  # changed.
825
845
  #
846
+ # The `Edition` parameter is optional. If you don't supply a value, the
847
+ # default is `ENTERPRISE_EDITION`.
848
+ #
826
849
  # @option params [required, String] :role_arn
827
850
  # An IAM role that gives Amazon Kendra permissions to access your Amazon
828
851
  # CloudWatch logs and metrics. This is also the role used when you use
@@ -1053,6 +1076,7 @@ module Aws::Kendra
1053
1076
  # resp.configuration.database_configuration.column_configuration.change_detecting_columns #=> Array
1054
1077
  # resp.configuration.database_configuration.column_configuration.change_detecting_columns[0] #=> String
1055
1078
  # resp.configuration.database_configuration.acl_configuration.allowed_groups_column_name #=> String
1079
+ # resp.configuration.database_configuration.sql_configuration.query_identifiers_enclosing_option #=> String, one of "DOUBLE_QUOTES", "NONE"
1056
1080
  # resp.configuration.salesforce_configuration.server_url #=> String
1057
1081
  # resp.configuration.salesforce_configuration.secret_arn #=> String
1058
1082
  # resp.configuration.salesforce_configuration.standard_object_configurations #=> Array
@@ -1254,6 +1278,7 @@ module Aws::Kendra
1254
1278
  # resp.document_metadata_configurations[0].search.facetable #=> Boolean
1255
1279
  # resp.document_metadata_configurations[0].search.searchable #=> Boolean
1256
1280
  # resp.document_metadata_configurations[0].search.displayable #=> Boolean
1281
+ # resp.document_metadata_configurations[0].search.sortable #=> Boolean
1257
1282
  # resp.index_statistics.faq_statistics.indexed_question_answers_count #=> Integer
1258
1283
  # resp.index_statistics.text_document_statistics.indexed_text_documents_count #=> Integer
1259
1284
  # resp.index_statistics.text_document_statistics.indexed_text_bytes #=> Integer
@@ -1534,6 +1559,8 @@ module Aws::Kendra
1534
1559
  # You can specify that the query return only one type of result using
1535
1560
  # the `QueryResultTypeConfig` parameter.
1536
1561
  #
1562
+ # Each query returns the 100 most relevant results.
1563
+ #
1537
1564
  # @option params [required, String] :index_id
1538
1565
  # The unique identifier of the index to search. The identifier is
1539
1566
  # returned in the response from the operation.
@@ -1575,6 +1602,16 @@ module Aws::Kendra
1575
1602
  # The default page size is 10. The maximum number of results returned is
1576
1603
  # 100. If you ask for more than 100 results, only 100 are returned.
1577
1604
  #
1605
+ # @option params [Types::SortingConfiguration] :sorting_configuration
1606
+ # Provides information that determines how the results of the query are
1607
+ # sorted. You can set the field that Amazon Kendra should sort the
1608
+ # results on, and specify whether the results should be sorted in
1609
+ # ascending or descending order. In the case of ties in sorting the
1610
+ # results, the results are sorted by relevance.
1611
+ #
1612
+ # If you don't provide sorting configuration, the results are sorted by
1613
+ # the relevance that Amazon Kendra determines for the result.
1614
+ #
1578
1615
  # @return [Types::QueryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1579
1616
  #
1580
1617
  # * {Types::QueryResult#query_id #query_id} => String
@@ -1674,6 +1711,10 @@ module Aws::Kendra
1674
1711
  # query_result_type_filter: "DOCUMENT", # accepts DOCUMENT, QUESTION_ANSWER, ANSWER
1675
1712
  # page_number: 1,
1676
1713
  # page_size: 1,
1714
+ # sorting_configuration: {
1715
+ # document_attribute_key: "DocumentAttributeKey", # required
1716
+ # sort_order: "DESC", # required, accepts DESC, ASC
1717
+ # },
1677
1718
  # })
1678
1719
  #
1679
1720
  # @example Response structure
@@ -1709,8 +1750,10 @@ module Aws::Kendra
1709
1750
  # resp.result_items[0].document_attributes[0].value.string_list_value[0] #=> String
1710
1751
  # resp.result_items[0].document_attributes[0].value.long_value #=> Integer
1711
1752
  # resp.result_items[0].document_attributes[0].value.date_value #=> Time
1753
+ # resp.result_items[0].score_attributes.score_confidence #=> String, one of "VERY_HIGH", "HIGH", "MEDIUM", "LOW"
1712
1754
  # resp.facet_results #=> Array
1713
1755
  # resp.facet_results[0].document_attribute_key #=> String
1756
+ # resp.facet_results[0].document_attribute_value_type #=> String, one of "STRING_VALUE", "STRING_LIST_VALUE", "LONG_VALUE", "DATE_VALUE"
1714
1757
  # resp.facet_results[0].document_attribute_value_count_pairs #=> Array
1715
1758
  # resp.facet_results[0].document_attribute_value_count_pairs[0].document_attribute_value.string_value #=> String
1716
1759
  # resp.facet_results[0].document_attribute_value_count_pairs[0].document_attribute_value.string_list_value #=> Array
@@ -1998,6 +2041,9 @@ module Aws::Kendra
1998
2041
  # acl_configuration: {
1999
2042
  # allowed_groups_column_name: "ColumnName", # required
2000
2043
  # },
2044
+ # sql_configuration: {
2045
+ # query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
2046
+ # },
2001
2047
  # },
2002
2048
  # salesforce_configuration: {
2003
2049
  # server_url: "Url", # required
@@ -2190,6 +2236,7 @@ module Aws::Kendra
2190
2236
  # facetable: false,
2191
2237
  # searchable: false,
2192
2238
  # displayable: false,
2239
+ # sortable: false,
2193
2240
  # },
2194
2241
  # },
2195
2242
  # ],
@@ -2221,7 +2268,7 @@ module Aws::Kendra
2221
2268
  params: params,
2222
2269
  config: config)
2223
2270
  context[:gem_name] = 'aws-sdk-kendra'
2224
- context[:gem_version] = '1.7.1'
2271
+ context[:gem_version] = '1.12.0'
2225
2272
  Seahorse::Client::Request.new(handlers, context)
2226
2273
  end
2227
2274
 
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -159,6 +161,7 @@ module Aws::Kendra
159
161
  PrincipalType = Shapes::StringShape.new(name: 'PrincipalType')
160
162
  QueryCapacityUnit = Shapes::IntegerShape.new(name: 'QueryCapacityUnit')
161
163
  QueryId = Shapes::StringShape.new(name: 'QueryId')
164
+ QueryIdentifiersEnclosingOption = Shapes::StringShape.new(name: 'QueryIdentifiersEnclosingOption')
162
165
  QueryRequest = Shapes::StructureShape.new(name: 'QueryRequest')
163
166
  QueryResult = Shapes::StructureShape.new(name: 'QueryResult')
164
167
  QueryResultItem = Shapes::StructureShape.new(name: 'QueryResultItem')
@@ -196,6 +199,8 @@ module Aws::Kendra
196
199
  SalesforceStandardObjectConfigurationList = Shapes::ListShape.new(name: 'SalesforceStandardObjectConfigurationList')
197
200
  SalesforceStandardObjectName = Shapes::StringShape.new(name: 'SalesforceStandardObjectName')
198
201
  ScanSchedule = Shapes::StringShape.new(name: 'ScanSchedule')
202
+ ScoreAttributes = Shapes::StructureShape.new(name: 'ScoreAttributes')
203
+ ScoreConfidence = Shapes::StringShape.new(name: 'ScoreConfidence')
199
204
  Search = Shapes::StructureShape.new(name: 'Search')
200
205
  SecretArn = Shapes::StringShape.new(name: 'SecretArn')
201
206
  SecurityGroupIdList = Shapes::ListShape.new(name: 'SecurityGroupIdList')
@@ -209,6 +214,9 @@ module Aws::Kendra
209
214
  SharePointConfiguration = Shapes::StructureShape.new(name: 'SharePointConfiguration')
210
215
  SharePointUrlList = Shapes::ListShape.new(name: 'SharePointUrlList')
211
216
  SharePointVersion = Shapes::StringShape.new(name: 'SharePointVersion')
217
+ SortOrder = Shapes::StringShape.new(name: 'SortOrder')
218
+ SortingConfiguration = Shapes::StructureShape.new(name: 'SortingConfiguration')
219
+ SqlConfiguration = Shapes::StructureShape.new(name: 'SqlConfiguration')
212
220
  StartDataSourceSyncJobRequest = Shapes::StructureShape.new(name: 'StartDataSourceSyncJobRequest')
213
221
  StartDataSourceSyncJobResponse = Shapes::StructureShape.new(name: 'StartDataSourceSyncJobResponse')
214
222
  StopDataSourceSyncJobRequest = Shapes::StructureShape.new(name: 'StopDataSourceSyncJobRequest')
@@ -429,6 +437,7 @@ module Aws::Kendra
429
437
  DatabaseConfiguration.add_member(:vpc_configuration, Shapes::ShapeRef.new(shape: DataSourceVpcConfiguration, location_name: "VpcConfiguration"))
430
438
  DatabaseConfiguration.add_member(:column_configuration, Shapes::ShapeRef.new(shape: ColumnConfiguration, required: true, location_name: "ColumnConfiguration"))
431
439
  DatabaseConfiguration.add_member(:acl_configuration, Shapes::ShapeRef.new(shape: AclConfiguration, location_name: "AclConfiguration"))
440
+ DatabaseConfiguration.add_member(:sql_configuration, Shapes::ShapeRef.new(shape: SqlConfiguration, location_name: "SqlConfiguration"))
432
441
  DatabaseConfiguration.struct_class = Types::DatabaseConfiguration
433
442
 
434
443
  DeleteDataSourceRequest.add_member(:id, Shapes::ShapeRef.new(shape: DataSourceId, required: true, location_name: "Id"))
@@ -546,6 +555,7 @@ module Aws::Kendra
546
555
  FacetList.member = Shapes::ShapeRef.new(shape: Facet)
547
556
 
548
557
  FacetResult.add_member(:document_attribute_key, Shapes::ShapeRef.new(shape: DocumentAttributeKey, location_name: "DocumentAttributeKey"))
558
+ FacetResult.add_member(:document_attribute_value_type, Shapes::ShapeRef.new(shape: DocumentAttributeValueType, location_name: "DocumentAttributeValueType"))
549
559
  FacetResult.add_member(:document_attribute_value_count_pairs, Shapes::ShapeRef.new(shape: DocumentAttributeValueCountPairList, location_name: "DocumentAttributeValueCountPairs"))
550
560
  FacetResult.struct_class = Types::FacetResult
551
561
 
@@ -660,6 +670,7 @@ module Aws::Kendra
660
670
  QueryRequest.add_member(:query_result_type_filter, Shapes::ShapeRef.new(shape: QueryResultType, location_name: "QueryResultTypeFilter"))
661
671
  QueryRequest.add_member(:page_number, Shapes::ShapeRef.new(shape: Integer, location_name: "PageNumber"))
662
672
  QueryRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: Integer, location_name: "PageSize"))
673
+ QueryRequest.add_member(:sorting_configuration, Shapes::ShapeRef.new(shape: SortingConfiguration, location_name: "SortingConfiguration"))
663
674
  QueryRequest.struct_class = Types::QueryRequest
664
675
 
665
676
  QueryResult.add_member(:query_id, Shapes::ShapeRef.new(shape: QueryId, location_name: "QueryId"))
@@ -676,6 +687,7 @@ module Aws::Kendra
676
687
  QueryResultItem.add_member(:document_excerpt, Shapes::ShapeRef.new(shape: TextWithHighlights, location_name: "DocumentExcerpt"))
677
688
  QueryResultItem.add_member(:document_uri, Shapes::ShapeRef.new(shape: Url, location_name: "DocumentURI"))
678
689
  QueryResultItem.add_member(:document_attributes, Shapes::ShapeRef.new(shape: DocumentAttributeList, location_name: "DocumentAttributes"))
690
+ QueryResultItem.add_member(:score_attributes, Shapes::ShapeRef.new(shape: ScoreAttributes, location_name: "ScoreAttributes"))
679
691
  QueryResultItem.struct_class = Types::QueryResultItem
680
692
 
681
693
  QueryResultItemList.member = Shapes::ShapeRef.new(shape: QueryResultItem)
@@ -767,9 +779,13 @@ module Aws::Kendra
767
779
 
768
780
  SalesforceStandardObjectConfigurationList.member = Shapes::ShapeRef.new(shape: SalesforceStandardObjectConfiguration)
769
781
 
782
+ ScoreAttributes.add_member(:score_confidence, Shapes::ShapeRef.new(shape: ScoreConfidence, location_name: "ScoreConfidence"))
783
+ ScoreAttributes.struct_class = Types::ScoreAttributes
784
+
770
785
  Search.add_member(:facetable, Shapes::ShapeRef.new(shape: Boolean, location_name: "Facetable"))
771
786
  Search.add_member(:searchable, Shapes::ShapeRef.new(shape: Boolean, location_name: "Searchable"))
772
787
  Search.add_member(:displayable, Shapes::ShapeRef.new(shape: Boolean, location_name: "Displayable"))
788
+ Search.add_member(:sortable, Shapes::ShapeRef.new(shape: Boolean, location_name: "Sortable"))
773
789
  Search.struct_class = Types::Search
774
790
 
775
791
  SecurityGroupIdList.member = Shapes::ShapeRef.new(shape: VpcSecurityGroupId)
@@ -817,6 +833,13 @@ module Aws::Kendra
817
833
 
818
834
  SharePointUrlList.member = Shapes::ShapeRef.new(shape: Url)
819
835
 
836
+ SortingConfiguration.add_member(:document_attribute_key, Shapes::ShapeRef.new(shape: DocumentAttributeKey, required: true, location_name: "DocumentAttributeKey"))
837
+ SortingConfiguration.add_member(:sort_order, Shapes::ShapeRef.new(shape: SortOrder, required: true, location_name: "SortOrder"))
838
+ SortingConfiguration.struct_class = Types::SortingConfiguration
839
+
840
+ SqlConfiguration.add_member(:query_identifiers_enclosing_option, Shapes::ShapeRef.new(shape: QueryIdentifiersEnclosingOption, location_name: "QueryIdentifiersEnclosingOption"))
841
+ SqlConfiguration.struct_class = Types::SqlConfiguration
842
+
820
843
  StartDataSourceSyncJobRequest.add_member(:id, Shapes::ShapeRef.new(shape: DataSourceId, required: true, location_name: "Id"))
821
844
  StartDataSourceSyncJobRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
822
845
  StartDataSourceSyncJobRequest.struct_class = Types::StartDataSourceSyncJobRequest
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -25,6 +27,7 @@ module Aws::Kendra
25
27
  #
26
28
  class AccessControlListConfiguration < Struct.new(
27
29
  :key_path)
30
+ SENSITIVE = []
28
31
  include Aws::Structure
29
32
  end
30
33
 
@@ -35,6 +38,7 @@ module Aws::Kendra
35
38
  #
36
39
  class AccessDeniedException < Struct.new(
37
40
  :message)
41
+ SENSITIVE = []
38
42
  include Aws::Structure
39
43
  end
40
44
 
@@ -59,6 +63,7 @@ module Aws::Kendra
59
63
  #
60
64
  class AclConfiguration < Struct.new(
61
65
  :allowed_groups_column_name)
66
+ SENSITIVE = []
62
67
  include Aws::Structure
63
68
  end
64
69
 
@@ -82,6 +87,7 @@ module Aws::Kendra
82
87
  :key,
83
88
  :value_type,
84
89
  :value)
90
+ SENSITIVE = []
85
91
  include Aws::Structure
86
92
  end
87
93
 
@@ -96,6 +102,7 @@ module Aws::Kendra
96
102
  #
97
103
  class AdditionalResultAttributeValue < Struct.new(
98
104
  :text_with_highlights_value)
105
+ SENSITIVE = []
99
106
  include Aws::Structure
100
107
  end
101
108
 
@@ -432,13 +439,13 @@ module Aws::Kendra
432
439
  #
433
440
  # @!attribute [rw] contains_all
434
441
  # Returns true when a document contains all of the specified document
435
- # attributes. This filter is only appicable to `StringListValue`
442
+ # attributes. This filter is only applicable to `StringListValue`
436
443
  # metadata.
437
444
  # @return [Types::DocumentAttribute]
438
445
  #
439
446
  # @!attribute [rw] contains_any
440
447
  # Returns true when a document contains any of the specified document
441
- # attributes.This filter is only appicable to `StringListValue`
448
+ # attributes. This filter is only applicable to `StringListValue`
442
449
  # metadata.
443
450
  # @return [Types::DocumentAttribute]
444
451
  #
@@ -476,6 +483,7 @@ module Aws::Kendra
476
483
  :greater_than_or_equals,
477
484
  :less_than,
478
485
  :less_than_or_equals)
486
+ SENSITIVE = []
479
487
  include Aws::Structure
480
488
  end
481
489
 
@@ -509,6 +517,7 @@ module Aws::Kendra
509
517
  :index_id,
510
518
  :document_id_list,
511
519
  :data_source_sync_job_metric_target)
520
+ SENSITIVE = []
512
521
  include Aws::Structure
513
522
  end
514
523
 
@@ -522,6 +531,7 @@ module Aws::Kendra
522
531
  #
523
532
  class BatchDeleteDocumentResponse < Struct.new(
524
533
  :failed_documents)
534
+ SENSITIVE = []
525
535
  include Aws::Structure
526
536
  end
527
537
 
@@ -549,6 +559,7 @@ module Aws::Kendra
549
559
  :id,
550
560
  :error_code,
551
561
  :error_message)
562
+ SENSITIVE = []
552
563
  include Aws::Structure
553
564
  end
554
565
 
@@ -630,6 +641,7 @@ module Aws::Kendra
630
641
  :index_id,
631
642
  :role_arn,
632
643
  :documents)
644
+ SENSITIVE = []
633
645
  include Aws::Structure
634
646
  end
635
647
 
@@ -652,6 +664,7 @@ module Aws::Kendra
652
664
  #
653
665
  class BatchPutDocumentResponse < Struct.new(
654
666
  :failed_documents)
667
+ SENSITIVE = []
655
668
  include Aws::Structure
656
669
  end
657
670
 
@@ -675,6 +688,7 @@ module Aws::Kendra
675
688
  :id,
676
689
  :error_code,
677
690
  :error_message)
691
+ SENSITIVE = []
678
692
  include Aws::Structure
679
693
  end
680
694
 
@@ -705,6 +719,7 @@ module Aws::Kendra
705
719
  class CapacityUnitsConfiguration < Struct.new(
706
720
  :storage_capacity_units,
707
721
  :query_capacity_units)
722
+ SENSITIVE = []
708
723
  include Aws::Structure
709
724
  end
710
725
 
@@ -733,6 +748,7 @@ module Aws::Kendra
733
748
  class ClickFeedback < Struct.new(
734
749
  :result_id,
735
750
  :click_time)
751
+ SENSITIVE = []
736
752
  include Aws::Structure
737
753
  end
738
754
 
@@ -787,6 +803,7 @@ module Aws::Kendra
787
803
  :document_title_column_name,
788
804
  :field_mappings,
789
805
  :change_detecting_columns)
806
+ SENSITIVE = []
790
807
  include Aws::Structure
791
808
  end
792
809
 
@@ -797,6 +814,7 @@ module Aws::Kendra
797
814
  #
798
815
  class ConflictException < Struct.new(
799
816
  :message)
817
+ SENSITIVE = []
800
818
  include Aws::Structure
801
819
  end
802
820
 
@@ -851,6 +869,7 @@ module Aws::Kendra
851
869
  :database_name,
852
870
  :table_name,
853
871
  :secret_arn)
872
+ SENSITIVE = []
854
873
  include Aws::Structure
855
874
  end
856
875
 
@@ -923,6 +942,9 @@ module Aws::Kendra
923
942
  # acl_configuration: {
924
943
  # allowed_groups_column_name: "ColumnName", # required
925
944
  # },
945
+ # sql_configuration: {
946
+ # query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
947
+ # },
926
948
  # },
927
949
  # salesforce_configuration: {
928
950
  # server_url: "Url", # required
@@ -1117,6 +1139,7 @@ module Aws::Kendra
1117
1139
  :schedule,
1118
1140
  :role_arn,
1119
1141
  :tags)
1142
+ SENSITIVE = []
1120
1143
  include Aws::Structure
1121
1144
  end
1122
1145
 
@@ -1128,6 +1151,7 @@ module Aws::Kendra
1128
1151
  #
1129
1152
  class CreateDataSourceResponse < Struct.new(
1130
1153
  :id)
1154
+ SENSITIVE = []
1131
1155
  include Aws::Structure
1132
1156
  end
1133
1157
 
@@ -1192,6 +1216,7 @@ module Aws::Kendra
1192
1216
  :s3_path,
1193
1217
  :role_arn,
1194
1218
  :tags)
1219
+ SENSITIVE = []
1195
1220
  include Aws::Structure
1196
1221
  end
1197
1222
 
@@ -1203,6 +1228,7 @@ module Aws::Kendra
1203
1228
  #
1204
1229
  class CreateFaqResponse < Struct.new(
1205
1230
  :id)
1231
+ SENSITIVE = []
1206
1232
  include Aws::Structure
1207
1233
  end
1208
1234
 
@@ -1236,6 +1262,9 @@ module Aws::Kendra
1236
1262
  # or proof of concept. Use `ENTERPRISE_EDITION` for your production
1237
1263
  # databases. Once you set the edition for an index, it can't be
1238
1264
  # changed.
1265
+ #
1266
+ # The `Edition` parameter is optional. If you don't supply a value,
1267
+ # the default is `ENTERPRISE_EDITION`.
1239
1268
  # @return [String]
1240
1269
  #
1241
1270
  # @!attribute [rw] role_arn
@@ -1280,6 +1309,7 @@ module Aws::Kendra
1280
1309
  :description,
1281
1310
  :client_token,
1282
1311
  :tags)
1312
+ SENSITIVE = []
1283
1313
  include Aws::Structure
1284
1314
  end
1285
1315
 
@@ -1292,6 +1322,7 @@ module Aws::Kendra
1292
1322
  #
1293
1323
  class CreateIndexResponse < Struct.new(
1294
1324
  :id)
1325
+ SENSITIVE = []
1295
1326
  include Aws::Structure
1296
1327
  end
1297
1328
 
@@ -1362,6 +1393,9 @@ module Aws::Kendra
1362
1393
  # acl_configuration: {
1363
1394
  # allowed_groups_column_name: "ColumnName", # required
1364
1395
  # },
1396
+ # sql_configuration: {
1397
+ # query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
1398
+ # },
1365
1399
  # },
1366
1400
  # salesforce_configuration: {
1367
1401
  # server_url: "Url", # required
@@ -1527,6 +1561,7 @@ module Aws::Kendra
1527
1561
  :salesforce_configuration,
1528
1562
  :one_drive_configuration,
1529
1563
  :service_now_configuration)
1564
+ SENSITIVE = []
1530
1565
  include Aws::Structure
1531
1566
  end
1532
1567
 
@@ -1567,6 +1602,7 @@ module Aws::Kendra
1567
1602
  :created_at,
1568
1603
  :updated_at,
1569
1604
  :status)
1605
+ SENSITIVE = []
1570
1606
  include Aws::Structure
1571
1607
  end
1572
1608
 
@@ -1625,6 +1661,7 @@ module Aws::Kendra
1625
1661
  :error_code,
1626
1662
  :data_source_error_code,
1627
1663
  :metrics)
1664
+ SENSITIVE = []
1628
1665
  include Aws::Structure
1629
1666
  end
1630
1667
 
@@ -1651,6 +1688,7 @@ module Aws::Kendra
1651
1688
  class DataSourceSyncJobMetricTarget < Struct.new(
1652
1689
  :data_source_id,
1653
1690
  :data_source_sync_job_id)
1691
+ SENSITIVE = []
1654
1692
  include Aws::Structure
1655
1693
  end
1656
1694
 
@@ -1691,6 +1729,7 @@ module Aws::Kendra
1691
1729
  :documents_deleted,
1692
1730
  :documents_failed,
1693
1731
  :documents_scanned)
1732
+ SENSITIVE = []
1694
1733
  include Aws::Structure
1695
1734
  end
1696
1735
 
@@ -1725,6 +1764,7 @@ module Aws::Kendra
1725
1764
  :data_source_field_name,
1726
1765
  :date_field_format,
1727
1766
  :index_field_name)
1767
+ SENSITIVE = []
1728
1768
  include Aws::Structure
1729
1769
  end
1730
1770
 
@@ -1755,6 +1795,7 @@ module Aws::Kendra
1755
1795
  class DataSourceVpcConfiguration < Struct.new(
1756
1796
  :subnet_ids,
1757
1797
  :security_group_ids)
1798
+ SENSITIVE = []
1758
1799
  include Aws::Structure
1759
1800
  end
1760
1801
 
@@ -1792,6 +1833,9 @@ module Aws::Kendra
1792
1833
  # acl_configuration: {
1793
1834
  # allowed_groups_column_name: "ColumnName", # required
1794
1835
  # },
1836
+ # sql_configuration: {
1837
+ # query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
1838
+ # },
1795
1839
  # }
1796
1840
  #
1797
1841
  # @!attribute [rw] database_engine_type
@@ -1816,6 +1860,11 @@ module Aws::Kendra
1816
1860
  # user context filtering.
1817
1861
  # @return [Types::AclConfiguration]
1818
1862
  #
1863
+ # @!attribute [rw] sql_configuration
1864
+ # Provides information about how Amazon Kendra uses quote marks around
1865
+ # SQL identifiers when querying a database data source.
1866
+ # @return [Types::SqlConfiguration]
1867
+ #
1819
1868
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DatabaseConfiguration AWS API Documentation
1820
1869
  #
1821
1870
  class DatabaseConfiguration < Struct.new(
@@ -1823,7 +1872,9 @@ module Aws::Kendra
1823
1872
  :connection_configuration,
1824
1873
  :vpc_configuration,
1825
1874
  :column_configuration,
1826
- :acl_configuration)
1875
+ :acl_configuration,
1876
+ :sql_configuration)
1877
+ SENSITIVE = []
1827
1878
  include Aws::Structure
1828
1879
  end
1829
1880
 
@@ -1848,6 +1899,7 @@ module Aws::Kendra
1848
1899
  class DeleteDataSourceRequest < Struct.new(
1849
1900
  :id,
1850
1901
  :index_id)
1902
+ SENSITIVE = []
1851
1903
  include Aws::Structure
1852
1904
  end
1853
1905
 
@@ -1872,6 +1924,7 @@ module Aws::Kendra
1872
1924
  class DeleteFaqRequest < Struct.new(
1873
1925
  :id,
1874
1926
  :index_id)
1927
+ SENSITIVE = []
1875
1928
  include Aws::Structure
1876
1929
  end
1877
1930
 
@@ -1890,6 +1943,7 @@ module Aws::Kendra
1890
1943
  #
1891
1944
  class DeleteIndexRequest < Struct.new(
1892
1945
  :id)
1946
+ SENSITIVE = []
1893
1947
  include Aws::Structure
1894
1948
  end
1895
1949
 
@@ -1914,6 +1968,7 @@ module Aws::Kendra
1914
1968
  class DescribeDataSourceRequest < Struct.new(
1915
1969
  :id,
1916
1970
  :index_id)
1971
+ SENSITIVE = []
1917
1972
  include Aws::Structure
1918
1973
  end
1919
1974
 
@@ -1988,6 +2043,7 @@ module Aws::Kendra
1988
2043
  :schedule,
1989
2044
  :role_arn,
1990
2045
  :error_message)
2046
+ SENSITIVE = []
1991
2047
  include Aws::Structure
1992
2048
  end
1993
2049
 
@@ -2012,6 +2068,7 @@ module Aws::Kendra
2012
2068
  class DescribeFaqRequest < Struct.new(
2013
2069
  :id,
2014
2070
  :index_id)
2071
+ SENSITIVE = []
2015
2072
  include Aws::Structure
2016
2073
  end
2017
2074
 
@@ -2071,6 +2128,7 @@ module Aws::Kendra
2071
2128
  :status,
2072
2129
  :role_arn,
2073
2130
  :error_message)
2131
+ SENSITIVE = []
2074
2132
  include Aws::Structure
2075
2133
  end
2076
2134
 
@@ -2089,6 +2147,7 @@ module Aws::Kendra
2089
2147
  #
2090
2148
  class DescribeIndexRequest < Struct.new(
2091
2149
  :id)
2150
+ SENSITIVE = []
2092
2151
  include Aws::Structure
2093
2152
  end
2094
2153
 
@@ -2172,6 +2231,7 @@ module Aws::Kendra
2172
2231
  :index_statistics,
2173
2232
  :error_message,
2174
2233
  :capacity_units)
2234
+ SENSITIVE = []
2175
2235
  include Aws::Structure
2176
2236
  end
2177
2237
 
@@ -2256,6 +2316,7 @@ module Aws::Kendra
2256
2316
  :attributes,
2257
2317
  :access_control_list,
2258
2318
  :content_type)
2319
+ SENSITIVE = []
2259
2320
  include Aws::Structure
2260
2321
  end
2261
2322
 
@@ -2287,6 +2348,7 @@ module Aws::Kendra
2287
2348
  class DocumentAttribute < Struct.new(
2288
2349
  :key,
2289
2350
  :value)
2351
+ SENSITIVE = []
2290
2352
  include Aws::Structure
2291
2353
  end
2292
2354
 
@@ -2316,7 +2378,7 @@ module Aws::Kendra
2316
2378
  # @return [Integer]
2317
2379
  #
2318
2380
  # @!attribute [rw] date_value
2319
- # A date value expressed as seconds from the Unix epoch.
2381
+ # A date expressed as an ISO 8601 string.
2320
2382
  # @return [Time]
2321
2383
  #
2322
2384
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentAttributeValue AWS API Documentation
@@ -2326,6 +2388,7 @@ module Aws::Kendra
2326
2388
  :string_list_value,
2327
2389
  :long_value,
2328
2390
  :date_value)
2391
+ SENSITIVE = []
2329
2392
  include Aws::Structure
2330
2393
  end
2331
2394
 
@@ -2346,6 +2409,7 @@ module Aws::Kendra
2346
2409
  class DocumentAttributeValueCountPair < Struct.new(
2347
2410
  :document_attribute_value,
2348
2411
  :count)
2412
+ SENSITIVE = []
2349
2413
  include Aws::Structure
2350
2414
  end
2351
2415
 
@@ -2370,6 +2434,7 @@ module Aws::Kendra
2370
2434
  # facetable: false,
2371
2435
  # searchable: false,
2372
2436
  # displayable: false,
2437
+ # sortable: false,
2373
2438
  # },
2374
2439
  # }
2375
2440
  #
@@ -2397,6 +2462,7 @@ module Aws::Kendra
2397
2462
  :type,
2398
2463
  :relevance,
2399
2464
  :search)
2465
+ SENSITIVE = []
2400
2466
  include Aws::Structure
2401
2467
  end
2402
2468
 
@@ -2422,6 +2488,7 @@ module Aws::Kendra
2422
2488
  #
2423
2489
  class DocumentsMetadataConfiguration < Struct.new(
2424
2490
  :s3_prefix)
2491
+ SENSITIVE = []
2425
2492
  include Aws::Structure
2426
2493
  end
2427
2494
 
@@ -2442,6 +2509,7 @@ module Aws::Kendra
2442
2509
  #
2443
2510
  class Facet < Struct.new(
2444
2511
  :document_attribute_key)
2512
+ SENSITIVE = []
2445
2513
  include Aws::Structure
2446
2514
  end
2447
2515
 
@@ -2452,6 +2520,11 @@ module Aws::Kendra
2452
2520
  # `DocumentAttributeKey` provided in the query.
2453
2521
  # @return [String]
2454
2522
  #
2523
+ # @!attribute [rw] document_attribute_value_type
2524
+ # The data type of the facet value. This is the same as the type
2525
+ # defined for the index field when it was created.
2526
+ # @return [String]
2527
+ #
2455
2528
  # @!attribute [rw] document_attribute_value_count_pairs
2456
2529
  # An array of key/value pairs, where the key is the value of the
2457
2530
  # attribute and the count is the number of documents that share the
@@ -2462,7 +2535,9 @@ module Aws::Kendra
2462
2535
  #
2463
2536
  class FacetResult < Struct.new(
2464
2537
  :document_attribute_key,
2538
+ :document_attribute_value_type,
2465
2539
  :document_attribute_value_count_pairs)
2540
+ SENSITIVE = []
2466
2541
  include Aws::Structure
2467
2542
  end
2468
2543
 
@@ -2478,6 +2553,7 @@ module Aws::Kendra
2478
2553
  #
2479
2554
  class FaqStatistics < Struct.new(
2480
2555
  :indexed_question_answers_count)
2556
+ SENSITIVE = []
2481
2557
  include Aws::Structure
2482
2558
  end
2483
2559
 
@@ -2514,6 +2590,7 @@ module Aws::Kendra
2514
2590
  :status,
2515
2591
  :created_at,
2516
2592
  :updated_at)
2593
+ SENSITIVE = []
2517
2594
  include Aws::Structure
2518
2595
  end
2519
2596
 
@@ -2541,6 +2618,7 @@ module Aws::Kendra
2541
2618
  :begin_offset,
2542
2619
  :end_offset,
2543
2620
  :top_answer)
2621
+ SENSITIVE = []
2544
2622
  include Aws::Structure
2545
2623
  end
2546
2624
 
@@ -2584,6 +2662,7 @@ module Aws::Kendra
2584
2662
  :created_at,
2585
2663
  :updated_at,
2586
2664
  :status)
2665
+ SENSITIVE = []
2587
2666
  include Aws::Structure
2588
2667
  end
2589
2668
 
@@ -2603,6 +2682,7 @@ module Aws::Kendra
2603
2682
  class IndexStatistics < Struct.new(
2604
2683
  :faq_statistics,
2605
2684
  :text_document_statistics)
2685
+ SENSITIVE = []
2606
2686
  include Aws::Structure
2607
2687
  end
2608
2688
 
@@ -2613,6 +2693,7 @@ module Aws::Kendra
2613
2693
  #
2614
2694
  class InternalServerException < Struct.new(
2615
2695
  :message)
2696
+ SENSITIVE = []
2616
2697
  include Aws::Structure
2617
2698
  end
2618
2699
 
@@ -2670,6 +2751,7 @@ module Aws::Kendra
2670
2751
  :max_results,
2671
2752
  :start_time_filter,
2672
2753
  :status_filter)
2754
+ SENSITIVE = []
2673
2755
  include Aws::Structure
2674
2756
  end
2675
2757
 
@@ -2691,6 +2773,7 @@ module Aws::Kendra
2691
2773
  class ListDataSourceSyncJobsResponse < Struct.new(
2692
2774
  :history,
2693
2775
  :next_token)
2776
+ SENSITIVE = []
2694
2777
  include Aws::Structure
2695
2778
  end
2696
2779
 
@@ -2724,6 +2807,7 @@ module Aws::Kendra
2724
2807
  :index_id,
2725
2808
  :next_token,
2726
2809
  :max_results)
2810
+ SENSITIVE = []
2727
2811
  include Aws::Structure
2728
2812
  end
2729
2813
 
@@ -2742,6 +2826,7 @@ module Aws::Kendra
2742
2826
  class ListDataSourcesResponse < Struct.new(
2743
2827
  :summary_items,
2744
2828
  :next_token)
2829
+ SENSITIVE = []
2745
2830
  include Aws::Structure
2746
2831
  end
2747
2832
 
@@ -2775,6 +2860,7 @@ module Aws::Kendra
2775
2860
  :index_id,
2776
2861
  :next_token,
2777
2862
  :max_results)
2863
+ SENSITIVE = []
2778
2864
  include Aws::Structure
2779
2865
  end
2780
2866
 
@@ -2795,6 +2881,7 @@ module Aws::Kendra
2795
2881
  class ListFaqsResponse < Struct.new(
2796
2882
  :next_token,
2797
2883
  :faq_summary_items)
2884
+ SENSITIVE = []
2798
2885
  include Aws::Structure
2799
2886
  end
2800
2887
 
@@ -2822,6 +2909,7 @@ module Aws::Kendra
2822
2909
  class ListIndicesRequest < Struct.new(
2823
2910
  :next_token,
2824
2911
  :max_results)
2912
+ SENSITIVE = []
2825
2913
  include Aws::Structure
2826
2914
  end
2827
2915
 
@@ -2840,6 +2928,7 @@ module Aws::Kendra
2840
2928
  class ListIndicesResponse < Struct.new(
2841
2929
  :index_configuration_summary_items,
2842
2930
  :next_token)
2931
+ SENSITIVE = []
2843
2932
  include Aws::Structure
2844
2933
  end
2845
2934
 
@@ -2859,6 +2948,7 @@ module Aws::Kendra
2859
2948
  #
2860
2949
  class ListTagsForResourceRequest < Struct.new(
2861
2950
  :resource_arn)
2951
+ SENSITIVE = []
2862
2952
  include Aws::Structure
2863
2953
  end
2864
2954
 
@@ -2870,6 +2960,7 @@ module Aws::Kendra
2870
2960
  #
2871
2961
  class ListTagsForResourceResponse < Struct.new(
2872
2962
  :tags)
2963
+ SENSITIVE = []
2873
2964
  include Aws::Structure
2874
2965
  end
2875
2966
 
@@ -2949,6 +3040,7 @@ module Aws::Kendra
2949
3040
  :inclusion_patterns,
2950
3041
  :exclusion_patterns,
2951
3042
  :field_mappings)
3043
+ SENSITIVE = []
2952
3044
  include Aws::Structure
2953
3045
  end
2954
3046
 
@@ -2983,6 +3075,7 @@ module Aws::Kendra
2983
3075
  class OneDriveUsers < Struct.new(
2984
3076
  :one_drive_user_list,
2985
3077
  :one_drive_user_s3_path)
3078
+ SENSITIVE = []
2986
3079
  include Aws::Structure
2987
3080
  end
2988
3081
 
@@ -3015,6 +3108,7 @@ module Aws::Kendra
3015
3108
  :name,
3016
3109
  :type,
3017
3110
  :access)
3111
+ SENSITIVE = []
3018
3112
  include Aws::Structure
3019
3113
  end
3020
3114
 
@@ -3111,6 +3205,10 @@ module Aws::Kendra
3111
3205
  # query_result_type_filter: "DOCUMENT", # accepts DOCUMENT, QUESTION_ANSWER, ANSWER
3112
3206
  # page_number: 1,
3113
3207
  # page_size: 1,
3208
+ # sorting_configuration: {
3209
+ # document_attribute_key: "DocumentAttributeKey", # required
3210
+ # sort_order: "DESC", # required, accepts DESC, ASC
3211
+ # },
3114
3212
  # }
3115
3213
  #
3116
3214
  # @!attribute [rw] index_id
@@ -3163,6 +3261,17 @@ module Aws::Kendra
3163
3261
  # returned.
3164
3262
  # @return [Integer]
3165
3263
  #
3264
+ # @!attribute [rw] sorting_configuration
3265
+ # Provides information that determines how the results of the query
3266
+ # are sorted. You can set the field that Amazon Kendra should sort the
3267
+ # results on, and specify whether the results should be sorted in
3268
+ # ascending or descending order. In the case of ties in sorting the
3269
+ # results, the results are sorted by relevance.
3270
+ #
3271
+ # If you don't provide sorting configuration, the results are sorted
3272
+ # by the relevance that Amazon Kendra determines for the result.
3273
+ # @return [Types::SortingConfiguration]
3274
+ #
3166
3275
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryRequest AWS API Documentation
3167
3276
  #
3168
3277
  class QueryRequest < Struct.new(
@@ -3173,7 +3282,9 @@ module Aws::Kendra
3173
3282
  :requested_document_attributes,
3174
3283
  :query_result_type_filter,
3175
3284
  :page_number,
3176
- :page_size)
3285
+ :page_size,
3286
+ :sorting_configuration)
3287
+ SENSITIVE = []
3177
3288
  include Aws::Structure
3178
3289
  end
3179
3290
 
@@ -3193,8 +3304,9 @@ module Aws::Kendra
3193
3304
  # @return [Array<Types::FacetResult>]
3194
3305
  #
3195
3306
  # @!attribute [rw] total_number_of_results
3196
- # The number of items returned by the search. Use this to determine
3197
- # when you have requested the last set of results.
3307
+ # The total number of items found by the search; however, you can only
3308
+ # retrieve up to 100 items. For example, if the search found 192
3309
+ # items, you can only retrieve the first 100 of the items.
3198
3310
  # @return [Integer]
3199
3311
  #
3200
3312
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResult AWS API Documentation
@@ -3204,6 +3316,7 @@ module Aws::Kendra
3204
3316
  :result_items,
3205
3317
  :facet_results,
3206
3318
  :total_number_of_results)
3319
+ SENSITIVE = []
3207
3320
  include Aws::Structure
3208
3321
  end
3209
3322
 
@@ -3223,7 +3336,7 @@ module Aws::Kendra
3223
3336
  # @return [String]
3224
3337
  #
3225
3338
  # @!attribute [rw] additional_attributes
3226
- # One or more additional attribues associated with the query result.
3339
+ # One or more additional attributes associated with the query result.
3227
3340
  # @return [Array<Types::AdditionalResultAttribute>]
3228
3341
  #
3229
3342
  # @!attribute [rw] document_id
@@ -3250,6 +3363,18 @@ module Aws::Kendra
3250
3363
  # source URI (SourceUri) of the document.
3251
3364
  # @return [Array<Types::DocumentAttribute>]
3252
3365
  #
3366
+ # @!attribute [rw] score_attributes
3367
+ # Indicates the confidence that Amazon Kendra has that a result
3368
+ # matches the query that you provided. Each result is placed into a
3369
+ # bin that indicates the confidence, `VERY_HIGH`, `HIGH`, `MEDIUM` and
3370
+ # `LOW`. You can use the score to determine if a response meets the
3371
+ # confidence needed for your application.
3372
+ #
3373
+ # The field is only set to `LOW` when the `Type` field is set to
3374
+ # `DOCUMENT` and Amazon Kendra is not confident that the result
3375
+ # matches the query.
3376
+ # @return [Types::ScoreAttributes]
3377
+ #
3253
3378
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResultItem AWS API Documentation
3254
3379
  #
3255
3380
  class QueryResultItem < Struct.new(
@@ -3260,7 +3385,9 @@ module Aws::Kendra
3260
3385
  :document_title,
3261
3386
  :document_excerpt,
3262
3387
  :document_uri,
3263
- :document_attributes)
3388
+ :document_attributes,
3389
+ :score_attributes)
3390
+ SENSITIVE = []
3264
3391
  include Aws::Structure
3265
3392
  end
3266
3393
 
@@ -3343,6 +3470,7 @@ module Aws::Kendra
3343
3470
  :duration,
3344
3471
  :rank_order,
3345
3472
  :value_importance_map)
3473
+ SENSITIVE = []
3346
3474
  include Aws::Structure
3347
3475
  end
3348
3476
 
@@ -3372,6 +3500,7 @@ module Aws::Kendra
3372
3500
  class RelevanceFeedback < Struct.new(
3373
3501
  :result_id,
3374
3502
  :relevance_value)
3503
+ SENSITIVE = []
3375
3504
  include Aws::Structure
3376
3505
  end
3377
3506
 
@@ -3382,6 +3511,7 @@ module Aws::Kendra
3382
3511
  #
3383
3512
  class ResourceAlreadyExistException < Struct.new(
3384
3513
  :message)
3514
+ SENSITIVE = []
3385
3515
  include Aws::Structure
3386
3516
  end
3387
3517
 
@@ -3392,6 +3522,7 @@ module Aws::Kendra
3392
3522
  #
3393
3523
  class ResourceInUseException < Struct.new(
3394
3524
  :message)
3525
+ SENSITIVE = []
3395
3526
  include Aws::Structure
3396
3527
  end
3397
3528
 
@@ -3402,6 +3533,7 @@ module Aws::Kendra
3402
3533
  #
3403
3534
  class ResourceNotFoundException < Struct.new(
3404
3535
  :message)
3536
+ SENSITIVE = []
3405
3537
  include Aws::Structure
3406
3538
  end
3407
3539
 
@@ -3412,6 +3544,7 @@ module Aws::Kendra
3412
3544
  #
3413
3545
  class ResourceUnavailableException < Struct.new(
3414
3546
  :message)
3547
+ SENSITIVE = []
3415
3548
  include Aws::Structure
3416
3549
  end
3417
3550
 
@@ -3475,6 +3608,7 @@ module Aws::Kendra
3475
3608
  :exclusion_patterns,
3476
3609
  :documents_metadata_configuration,
3477
3610
  :access_control_list_configuration)
3611
+ SENSITIVE = []
3478
3612
  include Aws::Structure
3479
3613
  end
3480
3614
 
@@ -3501,6 +3635,7 @@ module Aws::Kendra
3501
3635
  class S3Path < Struct.new(
3502
3636
  :bucket,
3503
3637
  :key)
3638
+ SENSITIVE = []
3504
3639
  include Aws::Structure
3505
3640
  end
3506
3641
 
@@ -3554,6 +3689,7 @@ module Aws::Kendra
3554
3689
  :document_title_field_name,
3555
3690
  :field_mappings,
3556
3691
  :include_filter_types)
3692
+ SENSITIVE = []
3557
3693
  include Aws::Structure
3558
3694
  end
3559
3695
 
@@ -3722,6 +3858,7 @@ module Aws::Kendra
3722
3858
  :standard_object_attachment_configuration,
3723
3859
  :include_attachment_file_patterns,
3724
3860
  :exclude_attachment_file_patterns)
3861
+ SENSITIVE = []
3725
3862
  include Aws::Structure
3726
3863
  end
3727
3864
 
@@ -3770,6 +3907,7 @@ module Aws::Kendra
3770
3907
  :document_data_field_name,
3771
3908
  :document_title_field_name,
3772
3909
  :field_mappings)
3910
+ SENSITIVE = []
3773
3911
  include Aws::Structure
3774
3912
  end
3775
3913
 
@@ -3832,6 +3970,7 @@ module Aws::Kendra
3832
3970
  :included_states,
3833
3971
  :standard_knowledge_article_type_configuration,
3834
3972
  :custom_knowledge_article_type_configurations)
3973
+ SENSITIVE = []
3835
3974
  include Aws::Structure
3836
3975
  end
3837
3976
 
@@ -3873,6 +4012,7 @@ module Aws::Kendra
3873
4012
  :document_data_field_name,
3874
4013
  :document_title_field_name,
3875
4014
  :field_mappings)
4015
+ SENSITIVE = []
3876
4016
  include Aws::Structure
3877
4017
  end
3878
4018
 
@@ -3907,6 +4047,7 @@ module Aws::Kendra
3907
4047
  class SalesforceStandardObjectAttachmentConfiguration < Struct.new(
3908
4048
  :document_title_field_name,
3909
4049
  :field_mappings)
4050
+ SENSITIVE = []
3910
4051
  include Aws::Structure
3911
4052
  end
3912
4053
 
@@ -3956,6 +4097,22 @@ module Aws::Kendra
3956
4097
  :document_data_field_name,
3957
4098
  :document_title_field_name,
3958
4099
  :field_mappings)
4100
+ SENSITIVE = []
4101
+ include Aws::Structure
4102
+ end
4103
+
4104
+ # Provides a relative ranking that indicates how confident Amazon Kendra
4105
+ # is that the response matches the query.
4106
+ #
4107
+ # @!attribute [rw] score_confidence
4108
+ # A relative ranking for how well the response matches the query.
4109
+ # @return [String]
4110
+ #
4111
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ScoreAttributes AWS API Documentation
4112
+ #
4113
+ class ScoreAttributes < Struct.new(
4114
+ :score_confidence)
4115
+ SENSITIVE = []
3959
4116
  include Aws::Structure
3960
4117
  end
3961
4118
 
@@ -3969,6 +4126,7 @@ module Aws::Kendra
3969
4126
  # facetable: false,
3970
4127
  # searchable: false,
3971
4128
  # displayable: false,
4129
+ # sortable: false,
3972
4130
  # }
3973
4131
  #
3974
4132
  # @!attribute [rw] facetable
@@ -3990,12 +4148,21 @@ module Aws::Kendra
3990
4148
  # default is `true`.
3991
4149
  # @return [Boolean]
3992
4150
  #
4151
+ # @!attribute [rw] sortable
4152
+ # Determines whether the field can be used to sort the results of a
4153
+ # query. If you specify sorting on a field that does not have
4154
+ # `Sortable` set to `true`, Amazon Kendra returns an exception. The
4155
+ # default is `false`.
4156
+ # @return [Boolean]
4157
+ #
3993
4158
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Search AWS API Documentation
3994
4159
  #
3995
4160
  class Search < Struct.new(
3996
4161
  :facetable,
3997
4162
  :searchable,
3998
- :displayable)
4163
+ :displayable,
4164
+ :sortable)
4165
+ SENSITIVE = []
3999
4166
  include Aws::Structure
4000
4167
  end
4001
4168
 
@@ -4019,6 +4186,7 @@ module Aws::Kendra
4019
4186
  #
4020
4187
  class ServerSideEncryptionConfiguration < Struct.new(
4021
4188
  :kms_key_id)
4189
+ SENSITIVE = [:kms_key_id]
4022
4190
  include Aws::Structure
4023
4191
  end
4024
4192
 
@@ -4097,6 +4265,7 @@ module Aws::Kendra
4097
4265
  :service_now_build_version,
4098
4266
  :knowledge_article_configuration,
4099
4267
  :service_catalog_configuration)
4268
+ SENSITIVE = []
4100
4269
  include Aws::Structure
4101
4270
  end
4102
4271
 
@@ -4162,6 +4331,7 @@ module Aws::Kendra
4162
4331
  :document_data_field_name,
4163
4332
  :document_title_field_name,
4164
4333
  :field_mappings)
4334
+ SENSITIVE = []
4165
4335
  include Aws::Structure
4166
4336
  end
4167
4337
 
@@ -4225,6 +4395,7 @@ module Aws::Kendra
4225
4395
  :document_data_field_name,
4226
4396
  :document_title_field_name,
4227
4397
  :field_mappings)
4398
+ SENSITIVE = []
4228
4399
  include Aws::Structure
4229
4400
  end
4230
4401
 
@@ -4235,6 +4406,7 @@ module Aws::Kendra
4235
4406
  #
4236
4407
  class ServiceQuotaExceededException < Struct.new(
4237
4408
  :message)
4409
+ SENSITIVE = []
4238
4410
  include Aws::Structure
4239
4411
  end
4240
4412
 
@@ -4314,7 +4486,7 @@ module Aws::Kendra
4314
4486
  # @return [Array<String>]
4315
4487
  #
4316
4488
  # @!attribute [rw] exclusion_patterns
4317
- # A list of regulary expression patterns. Documents that match the
4489
+ # A list of regular expression patterns. Documents that match the
4318
4490
  # patterns are excluded from the index. Documents that don't match
4319
4491
  # the patterns are included in the index. If a document matches both
4320
4492
  # an exclusion pattern and an inclusion pattern, the document is not
@@ -4357,6 +4529,101 @@ module Aws::Kendra
4357
4529
  :vpc_configuration,
4358
4530
  :field_mappings,
4359
4531
  :document_title_field_name)
4532
+ SENSITIVE = []
4533
+ include Aws::Structure
4534
+ end
4535
+
4536
+ # Specifies the document attribute to use to sort the response to a
4537
+ # Amazon Kendra query. You can specify a single attribute for sorting.
4538
+ # The attribute must have the `Sortable` flag set to `true`, otherwise
4539
+ # Amazon Kendra returns an exception.
4540
+ #
4541
+ # You can sort attributes of the following types.
4542
+ #
4543
+ # * Date value
4544
+ #
4545
+ # * Long value
4546
+ #
4547
+ # * String value
4548
+ #
4549
+ # You can't sort attributes of the following type.
4550
+ #
4551
+ # * String list value
4552
+ #
4553
+ # ^
4554
+ #
4555
+ # @note When making an API call, you may pass SortingConfiguration
4556
+ # data as a hash:
4557
+ #
4558
+ # {
4559
+ # document_attribute_key: "DocumentAttributeKey", # required
4560
+ # sort_order: "DESC", # required, accepts DESC, ASC
4561
+ # }
4562
+ #
4563
+ # @!attribute [rw] document_attribute_key
4564
+ # The name of the document attribute used to sort the response. You
4565
+ # can use any field that has the `Sortable` flag set to true.
4566
+ #
4567
+ # You can also sort by any of the following built-in attributes:
4568
+ #
4569
+ # * \_category
4570
+ #
4571
+ # * \_created\_at
4572
+ #
4573
+ # * \_last\_updated\_at
4574
+ #
4575
+ # * \_version
4576
+ #
4577
+ # * \_view\_count
4578
+ # @return [String]
4579
+ #
4580
+ # @!attribute [rw] sort_order
4581
+ # The order that the results should be returned in. In case of ties,
4582
+ # the relevance assigned to the result by Amazon Kendra is used as the
4583
+ # tie-breaker.
4584
+ # @return [String]
4585
+ #
4586
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SortingConfiguration AWS API Documentation
4587
+ #
4588
+ class SortingConfiguration < Struct.new(
4589
+ :document_attribute_key,
4590
+ :sort_order)
4591
+ SENSITIVE = []
4592
+ include Aws::Structure
4593
+ end
4594
+
4595
+ # Provides information that configures Amazon Kendra to use a SQL
4596
+ # database.
4597
+ #
4598
+ # @note When making an API call, you may pass SqlConfiguration
4599
+ # data as a hash:
4600
+ #
4601
+ # {
4602
+ # query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
4603
+ # }
4604
+ #
4605
+ # @!attribute [rw] query_identifiers_enclosing_option
4606
+ # Determines whether Amazon Kendra encloses SQL identifiers for tables
4607
+ # and column names in double quotes (") when making a database query.
4608
+ #
4609
+ # By default, Amazon Kendra passes SQL identifiers the way that they
4610
+ # are entered into the data source configuration. It does not change
4611
+ # the case of identifiers or enclose them in quotes.
4612
+ #
4613
+ # PostgreSQL internally converts uppercase characters to lower case
4614
+ # characters in identifiers unless they are quoted. Choosing this
4615
+ # option encloses identifiers in quotes so that PostgreSQL does not
4616
+ # convert the character's case.
4617
+ #
4618
+ # For MySQL databases, you must enable the `ansi_quotes` option when
4619
+ # you set this field to `DOUBLE_QUOTES`.
4620
+ # @return [String]
4621
+ #
4622
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SqlConfiguration AWS API Documentation
4623
+ #
4624
+ class SqlConfiguration < Struct.new(
4625
+ :query_identifiers_enclosing_option)
4626
+ SENSITIVE = []
4360
4627
  include Aws::Structure
4361
4628
  end
4362
4629
 
@@ -4381,6 +4648,7 @@ module Aws::Kendra
4381
4648
  class StartDataSourceSyncJobRequest < Struct.new(
4382
4649
  :id,
4383
4650
  :index_id)
4651
+ SENSITIVE = []
4384
4652
  include Aws::Structure
4385
4653
  end
4386
4654
 
@@ -4392,6 +4660,7 @@ module Aws::Kendra
4392
4660
  #
4393
4661
  class StartDataSourceSyncJobResponse < Struct.new(
4394
4662
  :execution_id)
4663
+ SENSITIVE = []
4395
4664
  include Aws::Structure
4396
4665
  end
4397
4666
 
@@ -4417,6 +4686,7 @@ module Aws::Kendra
4417
4686
  class StopDataSourceSyncJobRequest < Struct.new(
4418
4687
  :id,
4419
4688
  :index_id)
4689
+ SENSITIVE = []
4420
4690
  include Aws::Structure
4421
4691
  end
4422
4692
 
@@ -4466,6 +4736,7 @@ module Aws::Kendra
4466
4736
  :query_id,
4467
4737
  :click_feedback_items,
4468
4738
  :relevance_feedback_items)
4739
+ SENSITIVE = []
4469
4740
  include Aws::Structure
4470
4741
  end
4471
4742
 
@@ -4496,6 +4767,7 @@ module Aws::Kendra
4496
4767
  class Tag < Struct.new(
4497
4768
  :key,
4498
4769
  :value)
4770
+ SENSITIVE = []
4499
4771
  include Aws::Structure
4500
4772
  end
4501
4773
 
@@ -4528,6 +4800,7 @@ module Aws::Kendra
4528
4800
  class TagResourceRequest < Struct.new(
4529
4801
  :resource_arn,
4530
4802
  :tags)
4803
+ SENSITIVE = []
4531
4804
  include Aws::Structure
4532
4805
  end
4533
4806
 
@@ -4550,6 +4823,7 @@ module Aws::Kendra
4550
4823
  class TextDocumentStatistics < Struct.new(
4551
4824
  :indexed_text_documents_count,
4552
4825
  :indexed_text_bytes)
4826
+ SENSITIVE = []
4553
4827
  include Aws::Structure
4554
4828
  end
4555
4829
 
@@ -4568,6 +4842,7 @@ module Aws::Kendra
4568
4842
  class TextWithHighlights < Struct.new(
4569
4843
  :text,
4570
4844
  :highlights)
4845
+ SENSITIVE = []
4571
4846
  include Aws::Structure
4572
4847
  end
4573
4848
 
@@ -4578,6 +4853,7 @@ module Aws::Kendra
4578
4853
  #
4579
4854
  class ThrottlingException < Struct.new(
4580
4855
  :message)
4856
+ SENSITIVE = []
4581
4857
  include Aws::Structure
4582
4858
  end
4583
4859
 
@@ -4604,6 +4880,7 @@ module Aws::Kendra
4604
4880
  class TimeRange < Struct.new(
4605
4881
  :start_time,
4606
4882
  :end_time)
4883
+ SENSITIVE = []
4607
4884
  include Aws::Structure
4608
4885
  end
4609
4886
 
@@ -4630,6 +4907,7 @@ module Aws::Kendra
4630
4907
  class UntagResourceRequest < Struct.new(
4631
4908
  :resource_arn,
4632
4909
  :tag_keys)
4910
+ SENSITIVE = []
4633
4911
  include Aws::Structure
4634
4912
  end
4635
4913
 
@@ -4706,6 +4984,9 @@ module Aws::Kendra
4706
4984
  # acl_configuration: {
4707
4985
  # allowed_groups_column_name: "ColumnName", # required
4708
4986
  # },
4987
+ # sql_configuration: {
4988
+ # query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
4989
+ # },
4709
4990
  # },
4710
4991
  # salesforce_configuration: {
4711
4992
  # server_url: "Url", # required
@@ -4878,6 +5159,7 @@ module Aws::Kendra
4878
5159
  :description,
4879
5160
  :schedule,
4880
5161
  :role_arn)
5162
+ SENSITIVE = []
4881
5163
  include Aws::Structure
4882
5164
  end
4883
5165
 
@@ -4906,6 +5188,7 @@ module Aws::Kendra
4906
5188
  # facetable: false,
4907
5189
  # searchable: false,
4908
5190
  # displayable: false,
5191
+ # sortable: false,
4909
5192
  # },
4910
5193
  # },
4911
5194
  # ],
@@ -4955,6 +5238,7 @@ module Aws::Kendra
4955
5238
  :description,
4956
5239
  :document_metadata_configuration_updates,
4957
5240
  :capacity_units)
5241
+ SENSITIVE = []
4958
5242
  include Aws::Structure
4959
5243
  end
4960
5244
 
@@ -4965,6 +5249,7 @@ module Aws::Kendra
4965
5249
  #
4966
5250
  class ValidationException < Struct.new(
4967
5251
  :message)
5252
+ SENSITIVE = []
4968
5253
  include Aws::Structure
4969
5254
  end
4970
5255