aws-sdk-kendra 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85405515fd60d8582ec6e77da776ad2f56d5b4d61c70f0e21a147b280485c7de
-  data.tar.gz: f368c2afdbf681b8a342c50282249794e223b810463742c7d94b2f5659a05d4d
+  metadata.gz: ca0c4ed0efc6c1e08201507353f1b6edb0bc92cf0e99befefa76a1341e840caf
+  data.tar.gz: 000c145ddfcf960c317d7e8a8c20aa1118215f60da5ef766b1bedb500c5abecb
 SHA512:
-  metadata.gz: f60098a6ae9b6e4543fd03c8a9fb32b6e3931a74ba0d319fd927c5ce9732667575351353f307cd3b777821db85feedc99218157b1df2b5433ccdd020a5d01e16
-  data.tar.gz: 5ab1998965d531150fe2915d8c8042d6d80c05b181b26c77191b1d9969d3c014aecb1a5a1e003fda16284cbf74f09bebc415b0ea9289348e331d4d7b6c2f3bdd
+  metadata.gz: 2518b211b329d7c1c3708bca80100366ccdf8f4b7ac199d02173afa391ce97db529e61d1463837bd3c61d883676dd6fd409f6ae8376b06075d8dd2333262f01d
+  data.tar.gz: cebff54087acbb01288a4d5dad7fdf7b45ff0b5fe3e3d7ec69303dadc472f1d2da4881b52f21aa47e7a3d1d7de565f3029dfdc1d41cf98696d3340de49d9c91f

data/lib/aws-sdk-kendra.rb

@@ -47,6 +47,6 @@ require_relative 'aws-sdk-kendra/customizations'
 # @service
 module Aws::Kendra
 
-  GEM_VERSION = '1.8.0'
+  GEM_VERSION = '1.9.0'
 
 end

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

@@ -592,6 +592,9 @@ module Aws::Kendra
     #         acl_configuration: {
     #           allowed_groups_column_name: "ColumnName", # required
     #         },
+    #         sql_configuration: {
+    #           query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
+    #         },
     #       },
     #       salesforce_configuration: {
     #         server_url: "Url", # required
@@ -1055,6 +1058,7 @@ module Aws::Kendra
     #   resp.configuration.database_configuration.column_configuration.change_detecting_columns #=> Array
     #   resp.configuration.database_configuration.column_configuration.change_detecting_columns[0] #=> String
     #   resp.configuration.database_configuration.acl_configuration.allowed_groups_column_name #=> String
+    #   resp.configuration.database_configuration.sql_configuration.query_identifiers_enclosing_option #=> String, one of "DOUBLE_QUOTES", "NONE"
     #   resp.configuration.salesforce_configuration.server_url #=> String
     #   resp.configuration.salesforce_configuration.secret_arn #=> String
     #   resp.configuration.salesforce_configuration.standard_object_configurations #=> Array
@@ -1256,6 +1260,7 @@ module Aws::Kendra
     #   resp.document_metadata_configurations[0].search.facetable #=> Boolean
     #   resp.document_metadata_configurations[0].search.searchable #=> Boolean
     #   resp.document_metadata_configurations[0].search.displayable #=> Boolean
+    #   resp.document_metadata_configurations[0].search.sortable #=> Boolean
     #   resp.index_statistics.faq_statistics.indexed_question_answers_count #=> Integer
     #   resp.index_statistics.text_document_statistics.indexed_text_documents_count #=> Integer
     #   resp.index_statistics.text_document_statistics.indexed_text_bytes #=> Integer
@@ -1577,6 +1582,16 @@ module Aws::Kendra
     #   The default page size is 10. The maximum number of results returned is
     #   100. If you ask for more than 100 results, only 100 are returned.
     #
+    # @option params [Types::SortingConfiguration] :sorting_configuration
+    #   Provides information that determines how the results of the query are
+    #   sorted. You can set the field that Amazon Kendra should sort the
+    #   results on, and specify whether the results should be sorted in
+    #   ascending or descending order. In the case of ties in sorting the
+    #   results, the results are sorted by relevance.
+    #
+    #   If you don't provide sorting configuration, the results are sorted by
+    #   the relevance that Amazon Kendra determines for the result.
+    #
     # @return [Types::QueryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::QueryResult#query_id #query_id} => String
@@ -1676,6 +1691,10 @@ module Aws::Kendra
     #     query_result_type_filter: "DOCUMENT", # accepts DOCUMENT, QUESTION_ANSWER, ANSWER
     #     page_number: 1,
     #     page_size: 1,
+    #     sorting_configuration: {
+    #       document_attribute_key: "DocumentAttributeKey", # required
+    #       sort_order: "DESC", # required, accepts DESC, ASC
+    #     },
     #   })
     #
     # @example Response structure
@@ -2000,6 +2019,9 @@ module Aws::Kendra
     #         acl_configuration: {
     #           allowed_groups_column_name: "ColumnName", # required
     #         },
+    #         sql_configuration: {
+    #           query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
+    #         },
     #       },
     #       salesforce_configuration: {
     #         server_url: "Url", # required
@@ -2192,6 +2214,7 @@ module Aws::Kendra
     #           facetable: false,
     #           searchable: false,
     #           displayable: false,
+    #           sortable: false,
     #         },
     #       },
     #     ],
@@ -2223,7 +2246,7 @@ module Aws::Kendra
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-kendra'
-      context[:gem_version] = '1.8.0'
+      context[:gem_version] = '1.9.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -161,6 +161,7 @@ module Aws::Kendra
     PrincipalType = Shapes::StringShape.new(name: 'PrincipalType')
     QueryCapacityUnit = Shapes::IntegerShape.new(name: 'QueryCapacityUnit')
     QueryId = Shapes::StringShape.new(name: 'QueryId')
+    QueryIdentifiersEnclosingOption = Shapes::StringShape.new(name: 'QueryIdentifiersEnclosingOption')
     QueryRequest = Shapes::StructureShape.new(name: 'QueryRequest')
     QueryResult = Shapes::StructureShape.new(name: 'QueryResult')
     QueryResultItem = Shapes::StructureShape.new(name: 'QueryResultItem')
@@ -211,6 +212,9 @@ module Aws::Kendra
     SharePointConfiguration = Shapes::StructureShape.new(name: 'SharePointConfiguration')
     SharePointUrlList = Shapes::ListShape.new(name: 'SharePointUrlList')
     SharePointVersion = Shapes::StringShape.new(name: 'SharePointVersion')
+    SortOrder = Shapes::StringShape.new(name: 'SortOrder')
+    SortingConfiguration = Shapes::StructureShape.new(name: 'SortingConfiguration')
+    SqlConfiguration = Shapes::StructureShape.new(name: 'SqlConfiguration')
     StartDataSourceSyncJobRequest = Shapes::StructureShape.new(name: 'StartDataSourceSyncJobRequest')
     StartDataSourceSyncJobResponse = Shapes::StructureShape.new(name: 'StartDataSourceSyncJobResponse')
     StopDataSourceSyncJobRequest = Shapes::StructureShape.new(name: 'StopDataSourceSyncJobRequest')
@@ -431,6 +435,7 @@ module Aws::Kendra
     DatabaseConfiguration.add_member(:vpc_configuration, Shapes::ShapeRef.new(shape: DataSourceVpcConfiguration, location_name: "VpcConfiguration"))
     DatabaseConfiguration.add_member(:column_configuration, Shapes::ShapeRef.new(shape: ColumnConfiguration, required: true, location_name: "ColumnConfiguration"))
     DatabaseConfiguration.add_member(:acl_configuration, Shapes::ShapeRef.new(shape: AclConfiguration, location_name: "AclConfiguration"))
+    DatabaseConfiguration.add_member(:sql_configuration, Shapes::ShapeRef.new(shape: SqlConfiguration, location_name: "SqlConfiguration"))
     DatabaseConfiguration.struct_class = Types::DatabaseConfiguration
 
     DeleteDataSourceRequest.add_member(:id, Shapes::ShapeRef.new(shape: DataSourceId, required: true, location_name: "Id"))
@@ -662,6 +667,7 @@ module Aws::Kendra
     QueryRequest.add_member(:query_result_type_filter, Shapes::ShapeRef.new(shape: QueryResultType, location_name: "QueryResultTypeFilter"))
     QueryRequest.add_member(:page_number, Shapes::ShapeRef.new(shape: Integer, location_name: "PageNumber"))
     QueryRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: Integer, location_name: "PageSize"))
+    QueryRequest.add_member(:sorting_configuration, Shapes::ShapeRef.new(shape: SortingConfiguration, location_name: "SortingConfiguration"))
     QueryRequest.struct_class = Types::QueryRequest
 
     QueryResult.add_member(:query_id, Shapes::ShapeRef.new(shape: QueryId, location_name: "QueryId"))
@@ -772,6 +778,7 @@ module Aws::Kendra
     Search.add_member(:facetable, Shapes::ShapeRef.new(shape: Boolean, location_name: "Facetable"))
     Search.add_member(:searchable, Shapes::ShapeRef.new(shape: Boolean, location_name: "Searchable"))
     Search.add_member(:displayable, Shapes::ShapeRef.new(shape: Boolean, location_name: "Displayable"))
+    Search.add_member(:sortable, Shapes::ShapeRef.new(shape: Boolean, location_name: "Sortable"))
     Search.struct_class = Types::Search
 
     SecurityGroupIdList.member = Shapes::ShapeRef.new(shape: VpcSecurityGroupId)
@@ -819,6 +826,13 @@ module Aws::Kendra
 
     SharePointUrlList.member = Shapes::ShapeRef.new(shape: Url)
 
+    SortingConfiguration.add_member(:document_attribute_key, Shapes::ShapeRef.new(shape: DocumentAttributeKey, required: true, location_name: "DocumentAttributeKey"))
+    SortingConfiguration.add_member(:sort_order, Shapes::ShapeRef.new(shape: SortOrder, required: true, location_name: "SortOrder"))
+    SortingConfiguration.struct_class = Types::SortingConfiguration
+
+    SqlConfiguration.add_member(:query_identifiers_enclosing_option, Shapes::ShapeRef.new(shape: QueryIdentifiersEnclosingOption, location_name: "QueryIdentifiersEnclosingOption"))
+    SqlConfiguration.struct_class = Types::SqlConfiguration
+
     StartDataSourceSyncJobRequest.add_member(:id, Shapes::ShapeRef.new(shape: DataSourceId, required: true, location_name: "Id"))
     StartDataSourceSyncJobRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
     StartDataSourceSyncJobRequest.struct_class = Types::StartDataSourceSyncJobRequest

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

@@ -942,6 +942,9 @@ module Aws::Kendra
     #             acl_configuration: {
     #               allowed_groups_column_name: "ColumnName", # required
     #             },
+    #             sql_configuration: {
+    #               query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
+    #             },
     #           },
     #           salesforce_configuration: {
     #             server_url: "Url", # required
@@ -1387,6 +1390,9 @@ module Aws::Kendra
     #           acl_configuration: {
     #             allowed_groups_column_name: "ColumnName", # required
     #           },
+    #           sql_configuration: {
+    #             query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
+    #           },
     #         },
     #         salesforce_configuration: {
     #           server_url: "Url", # required
@@ -1824,6 +1830,9 @@ module Aws::Kendra
     #         acl_configuration: {
     #           allowed_groups_column_name: "ColumnName", # required
     #         },
+    #         sql_configuration: {
+    #           query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
+    #         },
     #       }
     #
     # @!attribute [rw] database_engine_type
@@ -1848,6 +1857,11 @@ module Aws::Kendra
     #   user context filtering.
     #   @return [Types::AclConfiguration]
     #
+    # @!attribute [rw] sql_configuration
+    #   Provides information about how Amazon Kendra uses quote marks around
+    #   SQL identifiers when querying a database data source.
+    #   @return [Types::SqlConfiguration]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DatabaseConfiguration AWS API Documentation
     #
     class DatabaseConfiguration < Struct.new(
@@ -1855,7 +1869,8 @@ module Aws::Kendra
       :connection_configuration,
       :vpc_configuration,
       :column_configuration,
-      :acl_configuration)
+      :acl_configuration,
+      :sql_configuration)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2360,7 +2375,7 @@ module Aws::Kendra
     #   @return [Integer]
     #
     # @!attribute [rw] date_value
-    #   A date value expressed as seconds from the Unix epoch.
+    #   A date expressed as an ISO 8601 string.
     #   @return [Time]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentAttributeValue AWS API Documentation
@@ -2416,6 +2431,7 @@ module Aws::Kendra
     #           facetable: false,
     #           searchable: false,
     #           displayable: false,
+    #           sortable: false,
     #         },
     #       }
     #
@@ -3180,6 +3196,10 @@ module Aws::Kendra
     #         query_result_type_filter: "DOCUMENT", # accepts DOCUMENT, QUESTION_ANSWER, ANSWER
     #         page_number: 1,
     #         page_size: 1,
+    #         sorting_configuration: {
+    #           document_attribute_key: "DocumentAttributeKey", # required
+    #           sort_order: "DESC", # required, accepts DESC, ASC
+    #         },
     #       }
     #
     # @!attribute [rw] index_id
@@ -3232,6 +3252,17 @@ module Aws::Kendra
     #   returned.
     #   @return [Integer]
     #
+    # @!attribute [rw] sorting_configuration
+    #   Provides information that determines how the results of the query
+    #   are sorted. You can set the field that Amazon Kendra should sort the
+    #   results on, and specify whether the results should be sorted in
+    #   ascending or descending order. In the case of ties in sorting the
+    #   results, the results are sorted by relevance.
+    #
+    #   If you don't provide sorting configuration, the results are sorted
+    #   by the relevance that Amazon Kendra determines for the result.
+    #   @return [Types::SortingConfiguration]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryRequest AWS API Documentation
     #
     class QueryRequest < Struct.new(
@@ -3242,7 +3273,8 @@ module Aws::Kendra
       :requested_document_attributes,
       :query_result_type_filter,
       :page_number,
-      :page_size)
+      :page_size,
+      :sorting_configuration)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -4056,6 +4088,7 @@ module Aws::Kendra
     #         facetable: false,
     #         searchable: false,
     #         displayable: false,
+    #         sortable: false,
     #       }
     #
     # @!attribute [rw] facetable
@@ -4077,12 +4110,20 @@ module Aws::Kendra
     #   default is `true`.
     #   @return [Boolean]
     #
+    # @!attribute [rw] sortable
+    #   Determines whether the field can be used to sort the results of a
+    #   query. If you specify sorting on a field that does not have
+    #   `Sortable` set to `true`, Amazon Kendra returns an exception. The
+    #   default is `false`.
+    #   @return [Boolean]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Search AWS API Documentation
     #
     class Search < Struct.new(
       :facetable,
       :searchable,
-      :displayable)
+      :displayable,
+      :sortable)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -4407,7 +4448,7 @@ module Aws::Kendra
     #   @return [Array<String>]
     #
     # @!attribute [rw] exclusion_patterns
-    #   A list of regulary expression patterns. Documents that match the
+    #   A list of regular expression patterns. Documents that match the
     #   patterns are excluded from the index. Documents that don't match
     #   the patterns are included in the index. If a document matches both
     #   an exclusion pattern and an inclusion pattern, the document is not
@@ -4454,6 +4495,86 @@ module Aws::Kendra
       include Aws::Structure
     end
 
+    # Specifies the document attribute to use to sort the response to a
+    # Amazon Kendra query. You can specify a single attribute for sorting.
+    # The attribute must have the `Sortable` flag set to `true`, otherwise
+    # Amazon Kendra returns an exception.
+    #
+    # @note When making an API call, you may pass SortingConfiguration
+    #   data as a hash:
+    #
+    #       {
+    #         document_attribute_key: "DocumentAttributeKey", # required
+    #         sort_order: "DESC", # required, accepts DESC, ASC
+    #       }
+    #
+    # @!attribute [rw] document_attribute_key
+    #   The name of the document attribute used to sort the response. You
+    #   can use any field that has the `Sortable` flag set to true.
+    #
+    #   You can also sort by any of the following built-in attributes:
+    #
+    #   * \_category
+    #
+    #   * \_created\_at
+    #
+    #   * \_last\_updated\_at
+    #
+    #   * \_version
+    #
+    #   * \_view\_count
+    #   @return [String]
+    #
+    # @!attribute [rw] sort_order
+    #   The order that the results should be returned in. In case of ties,
+    #   the relevance assigned to the result by Amazon Kendra is used as the
+    #   tie-breaker.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SortingConfiguration AWS API Documentation
+    #
+    class SortingConfiguration < Struct.new(
+      :document_attribute_key,
+      :sort_order)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Provides information that configures Amazon Kendra to use a SQL
+    # database.
+    #
+    # @note When making an API call, you may pass SqlConfiguration
+    #   data as a hash:
+    #
+    #       {
+    #         query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
+    #       }
+    #
+    # @!attribute [rw] query_identifiers_enclosing_option
+    #   Determines whether Amazon Kendra encloses SQL identifiers in double
+    #   quotes (") when making a database query.
+    #
+    #   By default, Amazon Kendra passes SQL identifiers the way that they
+    #   are entered into the data source configuration. It does not change
+    #   the case of identifiers or enclose them in quotes.
+    #
+    #   PostgreSQL internally converts uppercase characters to lower case
+    #   characters in identifiers unless they are quoted. Choosing this
+    #   option encloses identifiers in quotes so that PostgreSQL does not
+    #   convert the character's case.
+    #
+    #   For MySQL databases, you must enable the `ansi_quotes` option when
+    #   you choose this option.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SqlConfiguration AWS API Documentation
+    #
+    class SqlConfiguration < Struct.new(
+      :query_identifiers_enclosing_option)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass StartDataSourceSyncJobRequest
     #   data as a hash:
     #
@@ -4811,6 +4932,9 @@ module Aws::Kendra
     #             acl_configuration: {
     #               allowed_groups_column_name: "ColumnName", # required
     #             },
+    #             sql_configuration: {
+    #               query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
+    #             },
     #           },
     #           salesforce_configuration: {
     #             server_url: "Url", # required
@@ -5012,6 +5136,7 @@ module Aws::Kendra
     #               facetable: false,
     #               searchable: false,
     #               displayable: false,
+    #               sortable: false,
     #             },
     #           },
     #         ],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-kendra
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-23 00:00:00.000000000 Z
+date: 2020-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core