aws-sdk-kendra 1.49.0 → 1.50.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c668e6dc4052d81dfeb31eefcd987c963f389d6faa326440fd72edf340a03cf4
-  data.tar.gz: f49b58d04333eec724e8b93488ea4eb66888a083d256b8e614dcdefcfc6fd254
+  metadata.gz: e6a6965973af33d92bbf4cc608275e3bc4541732260d918579e22e511489bb5f
+  data.tar.gz: 0cc5f5fd3094fd4c5003092d9d5c5990eefde7fcf979c1a6a36bccc2324dbdaa
 SHA512:
-  metadata.gz: b8ce75268fd4a7ec172972cd47ba4220a4acb9d694ecc9310396f45c46fb4c9f5c61721a0123aded5872eca60ff82a7736b8ce8e0b0ee0dafab21eef08e04b6c
-  data.tar.gz: 8f26bd5777cc7f273a2903bea9f7b02e2c10562b4319a04578dea5f0783f42733272dfbdf218005ec1fa2c9f26a12f42ab40593db0cdbbeca037e0544bf331a1
+  metadata.gz: 1a550a8ee7d74f4150d598980f6ab06347a41d8f07b7bb126fc9c11fc9445cbcc2dd4f4eb6d7aa376e0512c5f0bf3265dd29455657d2dff2f69a74380dc9bbbd
+  data.tar.gz: 7629850184c7aee4770c3c6a3d014acb661378f48f3b2ac8ccf7a72712394bf6e6cc78eee4d4a09184677c9eb047132a8fea65183a63e7dc9a1c8aa039007b2d

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.50.0 (2022-05-05)
+------------------
+
+* Feature - AWS Kendra now supports hierarchical facets for a query. For more information, see https://docs.aws.amazon.com/kendra/latest/dg/filtering.html
+
 1.49.0 (2022-04-19)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.49.0
+1.50.0

data/lib/aws-sdk-kendra/client.rb

@@ -3577,6 +3577,8 @@ module Aws::Kendra
     #   * {Types::ListFaqsResponse#next_token #next_token} => String
     #   * {Types::ListFaqsResponse#faq_summary_items #faq_summary_items} => Array<Types::FaqSummary>
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_faqs({
@@ -3640,6 +3642,8 @@ module Aws::Kendra
     #   * {Types::ListGroupsOlderThanOrderingIdResponse#groups_summaries #groups_summaries} => Array<Types::GroupSummary>
     #   * {Types::ListGroupsOlderThanOrderingIdResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_groups_older_than_ordering_id({
@@ -3748,6 +3752,8 @@ module Aws::Kendra
     #   * {Types::ListQuerySuggestionsBlockListsResponse#block_list_summary_items #block_list_summary_items} => Array<Types::QuerySuggestionsBlockListSummary>
     #   * {Types::ListQuerySuggestionsBlockListsResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_query_suggestions_block_lists({
@@ -3827,6 +3833,8 @@ module Aws::Kendra
     #   * {Types::ListThesauriResponse#next_token #next_token} => String
     #   * {Types::ListThesauriResponse#thesaurus_summary_items #thesaurus_summary_items} => Array<Types::ThesaurusSummary>
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_thesauri({
@@ -4018,13 +4026,13 @@ module Aws::Kendra
     #
     # @option params [Array<Types::Facet>] :facets
     #   An array of documents attributes. Amazon Kendra returns a count for
-    #   each attribute key specified. You can use this information to help
-    #   narrow the search for your user.
+    #   each attribute key specified. This helps your users narrow their
+    #   search.
     #
     # @option params [Array<String>] :requested_document_attributes
-    #   An array of document attributes to include in the response. No other
-    #   document attributes are included in the response. By default all
-    #   document attributes are included in the response.
+    #   An array of document attributes to include in the response. You can
+    #   limit the response to include certain document attributes. By default
+    #   all document attributes are included in the response.
     #
     # @option params [String] :query_result_type_filter
     #   Sets the type of query. Only results for the specified query type are
@@ -4174,6 +4182,10 @@ module Aws::Kendra
     #     facets: [
     #       {
     #         document_attribute_key: "DocumentAttributeKey",
+    #         facets: {
+    #           # recursive FacetList
+    #         },
+    #         max_results: 1,
     #       },
     #     ],
     #     requested_document_attributes: ["DocumentAttributeKey"],
@@ -4263,6 +4275,7 @@ module Aws::Kendra
     #   resp.facet_results[0].document_attribute_value_count_pairs[0].document_attribute_value.long_value #=> Integer
     #   resp.facet_results[0].document_attribute_value_count_pairs[0].document_attribute_value.date_value #=> Time
     #   resp.facet_results[0].document_attribute_value_count_pairs[0].count #=> Integer
+    #   resp.facet_results[0].document_attribute_value_count_pairs[0].facet_results #=> Types::FacetResultList
     #   resp.total_number_of_results #=> Integer
     #   resp.warnings #=> Array
     #   resp.warnings[0].message #=> String
@@ -5419,7 +5432,7 @@ module Aws::Kendra
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-kendra'
-      context[:gem_version] = '1.49.0'
+      context[:gem_version] = '1.50.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-kendra/client_api.rb

@@ -469,6 +469,7 @@ module Aws::Kendra
     Timestamp = Shapes::TimestampShape.new(name: 'Timestamp')
     Title = Shapes::StringShape.new(name: 'Title')
     Token = Shapes::StringShape.new(name: 'Token')
+    TopDocumentAttributeValueCountPairsSize = Shapes::IntegerShape.new(name: 'TopDocumentAttributeValueCountPairsSize')
     UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
     UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
     UpdateDataSourceRequest = Shapes::StructureShape.new(name: 'UpdateDataSourceRequest')
@@ -1120,6 +1121,7 @@ module Aws::Kendra
 
     DocumentAttributeValueCountPair.add_member(:document_attribute_value, Shapes::ShapeRef.new(shape: DocumentAttributeValue, location_name: "DocumentAttributeValue"))
     DocumentAttributeValueCountPair.add_member(:count, Shapes::ShapeRef.new(shape: Integer, location_name: "Count"))
+    DocumentAttributeValueCountPair.add_member(:facet_results, Shapes::ShapeRef.new(shape: FacetResultList, location_name: "FacetResults"))
     DocumentAttributeValueCountPair.struct_class = Types::DocumentAttributeValueCountPair
 
     DocumentAttributeValueCountPairList.member = Shapes::ShapeRef.new(shape: DocumentAttributeValueCountPair)
@@ -1205,6 +1207,8 @@ module Aws::Kendra
     ExperiencesSummaryList.member = Shapes::ShapeRef.new(shape: ExperiencesSummary)
 
     Facet.add_member(:document_attribute_key, Shapes::ShapeRef.new(shape: DocumentAttributeKey, location_name: "DocumentAttributeKey"))
+    Facet.add_member(:facets, Shapes::ShapeRef.new(shape: FacetList, location_name: "Facets"))
+    Facet.add_member(:max_results, Shapes::ShapeRef.new(shape: TopDocumentAttributeValueCountPairsSize, location_name: "MaxResults"))
     Facet.struct_class = Types::Facet
 
     FacetList.member = Shapes::ShapeRef.new(shape: Facet)
@@ -2536,6 +2540,12 @@ module Aws::Kendra
         o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
         o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
         o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
       end)
 
       api.add_operation(:list_groups_older_than_ordering_id, Seahorse::Model::Operation.new.tap do |o|
@@ -2550,6 +2560,12 @@ module Aws::Kendra
         o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
         o.errors << Shapes::ShapeRef.new(shape: ConflictException)
         o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
       end)
 
       api.add_operation(:list_indices, Seahorse::Model::Operation.new.tap do |o|
@@ -2581,6 +2597,12 @@ module Aws::Kendra
         o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
         o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
         o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
       end)
 
       api.add_operation(:list_tags_for_resource, Seahorse::Model::Operation.new.tap do |o|
@@ -2607,6 +2629,12 @@ module Aws::Kendra
         o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
         o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
         o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
       end)
 
       api.add_operation(:put_principal_mapping, Seahorse::Model::Operation.new.tap do |o|

data/lib/aws-sdk-kendra/types.rb

@@ -5583,10 +5583,8 @@ module Aws::Kendra
       include Aws::Structure
     end
 
-    # A custom attribute value assigned to a document.
-    #
-    # For more information on how to create custom document attributes, see
-    # [Custom Attributes][1].
+    # A document attribute or metadata field. To create custom document
+    # attributes, see [Custom attributes][1].
     #
     #
     #
@@ -5760,8 +5758,8 @@ module Aws::Kendra
       include Aws::Structure
     end
 
-    # The value of a custom document attribute. You can only provide one
-    # value for a custom attribute.
+    # The value of a document attribute. You can only provide one value for
+    # a document attribute.
     #
     # @note When making an API call, you may pass DocumentAttributeValue
     #   data as a hash:
@@ -5809,7 +5807,7 @@ module Aws::Kendra
     # doing a faceted search.
     #
     # @!attribute [rw] document_attribute_value
-    #   The value of the attribute. For example, "HR."
+    #   The value of the attribute. For example, "HR".
     #   @return [Types::DocumentAttributeValue]
     #
     # @!attribute [rw] count
@@ -5817,11 +5815,27 @@ module Aws::Kendra
     #   value for the key.
     #   @return [Integer]
     #
+    # @!attribute [rw] facet_results
+    #   Contains the results of a document attribute that is a nested facet.
+    #   A `FacetResult` contains the counts for each facet nested within a
+    #   facet.
+    #
+    #   For example, the document attribute or facet "Department" includes
+    #   a value called "Engineering". In addition, the document attribute
+    #   or facet "SubDepartment" includes the values "Frontend" and
+    #   "Backend" for documents assigned to "Engineering". You can
+    #   display nested facets in the search results so that documents can be
+    #   searched not only by department but also by a sub department within
+    #   a department. The counts for documents that belong to "Frontend"
+    #   and "Backend" within "Engineering" are returned for a query.
+    #   @return [Array<Types::FacetResult>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentAttributeValueCountPair AWS API Documentation
     #
     class DocumentAttributeValueCountPair < Struct.new(
       :document_attribute_value,
-      :count)
+      :count,
+      :facet_results)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -6240,23 +6254,78 @@ module Aws::Kendra
       include Aws::Structure
     end
 
-    # Information about a document attribute
+    # Information about a document attribute. You can use document
+    # attributes as facets.
+    #
+    # For example, the document attribute or facet "Department" includes
+    # the values "HR", "Engineering", and "Accounting". You can
+    # display these values in the search results so that documents can be
+    # searched by department.
+    #
+    # You can display up to 10 facet values per facet for a query. If you
+    # want to increase this limit, contact [Support][1].
+    #
+    #
+    #
+    # [1]: http://aws.amazon.com/contact-us/
     #
     # @note When making an API call, you may pass Facet
     #   data as a hash:
     #
     #       {
     #         document_attribute_key: "DocumentAttributeKey",
+    #         facets: [
+    #           {
+    #             document_attribute_key: "DocumentAttributeKey",
+    #             facets: {
+    #               # recursive FacetList
+    #             },
+    #             max_results: 1,
+    #           },
+    #         ],
+    #         max_results: 1,
     #       }
     #
     # @!attribute [rw] document_attribute_key
     #   The unique key for the document attribute.
     #   @return [String]
     #
+    # @!attribute [rw] facets
+    #   An array of document attributes that are nested facets within a
+    #   facet.
+    #
+    #   For example, the document attribute or facet "Department" includes
+    #   a value called "Engineering". In addition, the document attribute
+    #   or facet "SubDepartment" includes the values "Frontend" and
+    #   "Backend" for documents assigned to "Engineering". You can
+    #   display nested facets in the search results so that documents can be
+    #   searched not only by department but also by a sub department within
+    #   a department. This helps your users further narrow their search.
+    #
+    #   You can only have one nested facet within a facet. If you want to
+    #   increase this limit, contact [Support][1].
+    #
+    #
+    #
+    #   [1]: http://aws.amazon.com/contact-us/
+    #   @return [Array<Types::Facet>]
+    #
+    # @!attribute [rw] max_results
+    #   Maximum number of facet values per facet. The default is 10. You can
+    #   use this to limit the number of facet values to less than 10. If you
+    #   want to increase the default, contact [Support][1].
+    #
+    #
+    #
+    #   [1]: http://aws.amazon.com/contact-us/
+    #   @return [Integer]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Facet AWS API Documentation
     #
     class Facet < Struct.new(
-      :document_attribute_key)
+      :document_attribute_key,
+      :facets,
+      :max_results)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -8409,6 +8478,10 @@ module Aws::Kendra
     #         facets: [
     #           {
     #             document_attribute_key: "DocumentAttributeKey",
+    #             facets: {
+    #               # recursive FacetList
+    #             },
+    #             max_results: 1,
     #           },
     #         ],
     #         requested_document_attributes: ["DocumentAttributeKey"],
@@ -8472,14 +8545,14 @@ module Aws::Kendra
     #
     # @!attribute [rw] facets
     #   An array of documents attributes. Amazon Kendra returns a count for
-    #   each attribute key specified. You can use this information to help
-    #   narrow the search for your user.
+    #   each attribute key specified. This helps your users narrow their
+    #   search.
     #   @return [Array<Types::Facet>]
     #
     # @!attribute [rw] requested_document_attributes
-    #   An array of document attributes to include in the response. No other
-    #   document attributes are included in the response. By default all
-    #   document attributes are included in the response.
+    #   An array of document attributes to include in the response. You can
+    #   limit the response to include certain document attributes. By
+    #   default all document attributes are included in the response.
     #   @return [Array<String>]
     #
     # @!attribute [rw] query_result_type_filter
@@ -8655,9 +8728,9 @@ module Aws::Kendra
     #   @return [String]
     #
     # @!attribute [rw] document_attributes
-    #   An array of document attributes for the document that the query
-    #   result maps to. For example, the document author (Author) or the
-    #   source URI (SourceUri) of the document.
+    #   An array of document attributes assigned to a document in the search
+    #   results. For example, the document author (`_author`) or the source
+    #   URI (`_source_uri`) of the document.
     #   @return [Array<Types::DocumentAttribute>]
     #
     # @!attribute [rw] score_attributes
@@ -8793,38 +8866,38 @@ module Aws::Kendra
     #       }
     #
     # @!attribute [rw] domain
-    #   The configuration information to connect to your Quip data source
-    #   domain.
+    #   The Quip site domain.
     #   @return [String]
     #
     # @!attribute [rw] secret_arn
     #   The Amazon Resource Name (ARN) of an Secrets Manager secret that
     #   contains the key-value pairs that are required to connect to your
-    #   Quip file system. Windows is currently the only supported type. The
-    #   secret must contain a JSON structure with the following keys:
+    #   Quip. The secret must contain a JSON structure with the following
+    #   keys:
     #
-    #   * username—The Active Directory user name, along with the Domain
-    #     Name System (DNS) domain name. For example,
-    #     *user@corp.example.com*. The Active Directory user account must
-    #     have read and mounting access to the Quip file system for Windows.
+    #   * accessToken—The token created in Quip. For more information, see
+    #     [Authentication for a Quip data source][1].
     #
-    #   * password—The password of the Active Directory user account with
-    #     read and mounting access to the Quip Windows file system.
+    #   ^
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html#quip-authentication
     #   @return [String]
     #
     # @!attribute [rw] crawl_file_comments
-    #   Specify whether to crawl file comments in your Quip data source. You
-    #   can specify one or more of these options.
+    #   Specify whether to crawl file comments in Quip. You can specify one
+    #   or more of these options.
     #   @return [Boolean]
     #
     # @!attribute [rw] crawl_chat_rooms
-    #   Specify whether to crawl chat rooms in your Quip data source. You
-    #   can specify one or more of these options.
+    #   Specify whether to crawl chat rooms in Quip. You can specify one or
+    #   more of these options.
     #   @return [Boolean]
     #
     # @!attribute [rw] crawl_attachments
-    #   Specify whether to crawl attachments in your Quip data source. You
-    #   can specify one or more of these options.
+    #   Specify whether to crawl attachments in Quip. You can specify one or
+    #   more of these options.
     #   @return [Boolean]
     #
     # @!attribute [rw] folder_ids
@@ -8832,15 +8905,42 @@ module Aws::Kendra
     #   @return [Array<String>]
     #
     # @!attribute [rw] thread_field_mappings
-    #   A list of field mappings to apply when indexing Quip threads.
+    #   A list of `DataSourceToIndexFieldMapping` objects that map
+    #   attributes or field names of Quip threads to Amazon Kendra index
+    #   field names. To create custom fields, use the `UpdateIndex` API
+    #   before you map to Quip fields. For more information, see [Mapping
+    #   data source fields][1]. The Quip field names must exist in your Quip
+    #   custom metadata.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
     #   @return [Array<Types::DataSourceToIndexFieldMapping>]
     #
     # @!attribute [rw] message_field_mappings
-    #   A list of field mappings to apply when indexing Quip messages.
+    #   A list of `DataSourceToIndexFieldMapping` objects that map
+    #   attributes or field names of Quip messages to Amazon Kendra index
+    #   field names. To create custom fields, use the `UpdateIndex` API
+    #   before you map to Quip fields. For more information, see [Mapping
+    #   data source fields][1]. The Quip field names must exist in your Quip
+    #   custom metadata.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
     #   @return [Array<Types::DataSourceToIndexFieldMapping>]
     #
     # @!attribute [rw] attachment_field_mappings
-    #   A list of field mappings to apply when indexing Quip attachments.
+    #   A list of `DataSourceToIndexFieldMapping` objects that map
+    #   attributes or field names of Quip attachments to Amazon Kendra index
+    #   field names. To create custom fields, use the `UpdateIndex` API
+    #   before you map to Quip fields. For more information, see [Mapping
+    #   data source fields][1]. The Quip field names must exist in your Quip
+    #   custom metadata.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
     #   @return [Array<Types::DataSourceToIndexFieldMapping>]
     #
     # @!attribute [rw] inclusion_patterns
@@ -8862,9 +8962,13 @@ module Aws::Kendra
     #   @return [Array<String>]
     #
     # @!attribute [rw] vpc_configuration
-    #   Configuration information for connecting to an Amazon Virtual
-    #   Private Cloud (VPC) for your Quip. Your Quip instance must reside
-    #   inside your VPC.
+    #   Configuration information for an Amazon Virtual Private Cloud (VPC)
+    #   to connect to your Quip. For more information, see [Configuring a
+    #   VPC][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
     #   @return [Types::DataSourceVpcConfiguration]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QuipConfiguration AWS API Documentation

data/lib/aws-sdk-kendra.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-kendra/customizations'
 # @!group service
 module Aws::Kendra
 
-  GEM_VERSION = '1.49.0'
+  GEM_VERSION = '1.50.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-kendra
 version: !ruby/object:Gem::Version
-  version: 1.49.0
+  version: 1.50.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-19 00:00:00.000000000 Z
+date: 2022-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core