aws-sdk-kendra 1.8.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85405515fd60d8582ec6e77da776ad2f56d5b4d61c70f0e21a147b280485c7de
-  data.tar.gz: f368c2afdbf681b8a342c50282249794e223b810463742c7d94b2f5659a05d4d
+  metadata.gz: 7b9c9e18500c2cbea326d60677c3102b7227620fc96f0057d724b670d2e9b42e
+  data.tar.gz: '08242ac7903468a85e7cf4a5a22ba00a4c8db4066aff18fc98b643161c111ee9'
 SHA512:
-  metadata.gz: f60098a6ae9b6e4543fd03c8a9fb32b6e3931a74ba0d319fd927c5ce9732667575351353f307cd3b777821db85feedc99218157b1df2b5433ccdd020a5d01e16
-  data.tar.gz: 5ab1998965d531150fe2915d8c8042d6d80c05b181b26c77191b1d9969d3c014aecb1a5a1e003fda16284cbf74f09bebc415b0ea9289348e331d4d7b6c2f3bdd
+  metadata.gz: be25a71903a5a73560a6298f08c232a3e0ee5b4e31b18e40e4ae1c63df47d28c0e3b2b1dd114c6902456351036acaf3a66afb2fe6b1e1ddb252eb0c5f210e174
+  data.tar.gz: f775c2be8b9b66783bf63ffc624335c02137cd73e228b2c396678fe5fd1d437d043267806712ca6f9b336d3d270b17b4e4a14d59dfb5091bdce44eaec0bae6a2

data/lib/aws-sdk-kendra.rb

@@ -7,6 +7,7 @@
 #
 # WARNING ABOUT GENERATED CODE
 
+
 require 'aws-sdk-core'
 require 'aws-sigv4'
 
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-kendra/customizations'
 #
 # See {Errors} for more information.
 #
-# @service
+# @!group service
 module Aws::Kendra
 
-  GEM_VERSION = '1.8.0'
+  GEM_VERSION = '1.13.0'
 
 end

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

@@ -85,13 +85,28 @@ module Aws::Kendra
     #     * `Aws::Credentials` - Used for configuring static, non-refreshing
     #       credentials.
     #
+    #     * `Aws::SharedCredentials` - Used for loading static credentials from a
+    #       shared file, such as `~/.aws/config`.
+    #
+    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #
+    #     * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
+    #       assume a role after providing credentials via the web.
+    #
+    #     * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
+    #       access token generated from `aws login`.
+    #
+    #     * `Aws::ProcessCredentials` - Used for loading credentials from a
+    #       process that outputs to stdout.
+    #
     #     * `Aws::InstanceProfileCredentials` - Used for loading credentials
     #       from an EC2 IMDS on an EC2 instance.
     #
-    #     * `Aws::SharedCredentials` - Used for loading credentials from a
-    #       shared file, such as `~/.aws/config`.
+    #     * `Aws::ECSCredentials` - Used for loading credentials from
+    #       instances running in ECS.
     #
-    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #     * `Aws::CognitoIdentityCredentials` - Used for loading credentials
+    #       from the Cognito Identity service.
     #
     #     When `:credentials` are not configured directly, the following
     #     locations will be searched for credentials:
@@ -101,10 +116,10 @@ module Aws::Kendra
     #     * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
     #     * `~/.aws/credentials`
     #     * `~/.aws/config`
-    #     * EC2 IMDS instance profile - When used by default, the timeouts are
-    #       very aggressive. Construct and pass an instance of
-    #       `Aws::InstanceProfileCredentails` to enable retries and extended
-    #       timeouts.
+    #     * EC2/ECS IMDS instance profile - When used by default, the timeouts
+    #       are very aggressive. Construct and pass an instance of
+    #       `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
+    #       enable retries and extended timeouts.
     #
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
@@ -471,12 +486,10 @@ module Aws::Kendra
 
     # Creates a data source that you use to with an Amazon Kendra index.
     #
-    # You specify a name, connector type and description for your data
-    # source. You can choose between an S3 connector, a SharePoint Online
-    # connector, and a database connector.
-    #
-    # You also specify configuration information such as document metadata
-    # (author, source URI, and so on) and user context information.
+    # You specify a name, data source connector type and description for
+    # your data source. You also specify configuration information such as
+    # document metadata (author, source URI, and so on) and user context
+    # information.
     #
     # `CreateDataSource` is a synchronous operation. The operation returns
     # 200 if the data source was successfully created. Otherwise, an
@@ -494,8 +507,8 @@ module Aws::Kendra
     #   The type of repository that contains the data source.
     #
     # @option params [required, Types::DataSourceConfiguration] :configuration
-    #   The connector configuration information that is required to access the
-    #   repository.
+    #   The data source connector configuration information that is required
+    #   to access the repository.
     #
     # @option params [String] :description
     #   A description for the data source.
@@ -592,6 +605,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
@@ -771,6 +787,20 @@ module Aws::Kendra
     #   to identify and organize your resources and to control access to
     #   resources.
     #
+    # @option params [String] :file_format
+    #   The format of the input file. You can choose between a basic CSV
+    #   format, a CSV format that includes customs attributes in a header, and
+    #   a JSON format that includes custom attributes.
+    #
+    #   The format must match the format of the file stored in the S3 bucket
+    #   identified in the `S3Path` parameter.
+    #
+    #   For more information, see [Adding questions and answers][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html
+    #
     # @return [Types::CreateFaqResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateFaqResponse#id #id} => String
@@ -792,6 +822,7 @@ module Aws::Kendra
     #         value: "TagValue", # required
     #       },
     #     ],
+    #     file_format: "CSV", # accepts CSV, CSV_WITH_HEADER, JSON
     #   })
     #
     # @example Response structure
@@ -825,6 +856,9 @@ module Aws::Kendra
     #   databases. Once you set the edition for an index, it can't be
     #   changed.
     #
+    #   The `Edition` parameter is optional. If you don't supply a value, the
+    #   default is `ENTERPRISE_EDITION`.
+    #
     # @option params [required, String] :role_arn
     #   An IAM role that gives Amazon Kendra permissions to access your Amazon
     #   CloudWatch logs and metrics. This is also the role used when you use
@@ -1055,6 +1089,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
@@ -1175,6 +1210,7 @@ module Aws::Kendra
     #   * {Types::DescribeFaqResponse#status #status} => String
     #   * {Types::DescribeFaqResponse#role_arn #role_arn} => String
     #   * {Types::DescribeFaqResponse#error_message #error_message} => String
+    #   * {Types::DescribeFaqResponse#file_format #file_format} => String
     #
     # @example Request syntax with placeholder values
     #
@@ -1196,6 +1232,7 @@ module Aws::Kendra
     #   resp.status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED"
     #   resp.role_arn #=> String
     #   resp.error_message #=> String
+    #   resp.file_format #=> String, one of "CSV", "CSV_WITH_HEADER", "JSON"
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaq AWS API Documentation
     #
@@ -1256,6 +1293,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
@@ -1429,6 +1467,7 @@ module Aws::Kendra
     #   resp.faq_summary_items[0].status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED"
     #   resp.faq_summary_items[0].created_at #=> Time
     #   resp.faq_summary_items[0].updated_at #=> Time
+    #   resp.faq_summary_items[0].file_format #=> String, one of "CSV", "CSV_WITH_HEADER", "JSON"
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqs AWS API Documentation
     #
@@ -1536,6 +1575,8 @@ module Aws::Kendra
     # You can specify that the query return only one type of result using
     # the `QueryResultTypeConfig` parameter.
     #
+    # Each query returns the 100 most relevant results.
+    #
     # @option params [required, String] :index_id
     #   The unique identifier of the index to search. The identifier is
     #   returned in the response from the operation.
@@ -1577,6 +1618,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 +1727,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
@@ -1711,8 +1766,10 @@ module Aws::Kendra
     #   resp.result_items[0].document_attributes[0].value.string_list_value[0] #=> String
     #   resp.result_items[0].document_attributes[0].value.long_value #=> Integer
     #   resp.result_items[0].document_attributes[0].value.date_value #=> Time
+    #   resp.result_items[0].score_attributes.score_confidence #=> String, one of "VERY_HIGH", "HIGH", "MEDIUM", "LOW"
     #   resp.facet_results #=> Array
     #   resp.facet_results[0].document_attribute_key #=> String
+    #   resp.facet_results[0].document_attribute_value_type #=> String, one of "STRING_VALUE", "STRING_LIST_VALUE", "LONG_VALUE", "DATE_VALUE"
     #   resp.facet_results[0].document_attribute_value_count_pairs #=> Array
     #   resp.facet_results[0].document_attribute_value_count_pairs[0].document_attribute_value.string_value #=> String
     #   resp.facet_results[0].document_attribute_value_count_pairs[0].document_attribute_value.string_list_value #=> Array
@@ -2000,6 +2057,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 +2252,7 @@ module Aws::Kendra
     #           facetable: false,
     #           searchable: false,
     #           displayable: false,
+    #           sortable: false,
     #         },
     #       },
     #     ],
@@ -2223,7 +2284,7 @@ module Aws::Kendra
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-kendra'
-      context[:gem_version] = '1.8.0'
+      context[:gem_version] = '1.13.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -110,6 +110,7 @@ module Aws::Kendra
     FacetList = Shapes::ListShape.new(name: 'FacetList')
     FacetResult = Shapes::StructureShape.new(name: 'FacetResult')
     FacetResultList = Shapes::ListShape.new(name: 'FacetResultList')
+    FaqFileFormat = Shapes::StringShape.new(name: 'FaqFileFormat')
     FaqId = Shapes::StringShape.new(name: 'FaqId')
     FaqName = Shapes::StringShape.new(name: 'FaqName')
     FaqStatistics = Shapes::StructureShape.new(name: 'FaqStatistics')
@@ -161,6 +162,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')
@@ -198,6 +200,8 @@ module Aws::Kendra
     SalesforceStandardObjectConfigurationList = Shapes::ListShape.new(name: 'SalesforceStandardObjectConfigurationList')
     SalesforceStandardObjectName = Shapes::StringShape.new(name: 'SalesforceStandardObjectName')
     ScanSchedule = Shapes::StringShape.new(name: 'ScanSchedule')
+    ScoreAttributes = Shapes::StructureShape.new(name: 'ScoreAttributes')
+    ScoreConfidence = Shapes::StringShape.new(name: 'ScoreConfidence')
     Search = Shapes::StructureShape.new(name: 'Search')
     SecretArn = Shapes::StringShape.new(name: 'SecretArn')
     SecurityGroupIdList = Shapes::ListShape.new(name: 'SecurityGroupIdList')
@@ -211,6 +215,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')
@@ -355,6 +362,7 @@ module Aws::Kendra
     CreateFaqRequest.add_member(:s3_path, Shapes::ShapeRef.new(shape: S3Path, required: true, location_name: "S3Path"))
     CreateFaqRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "RoleArn"))
     CreateFaqRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
+    CreateFaqRequest.add_member(:file_format, Shapes::ShapeRef.new(shape: FaqFileFormat, location_name: "FileFormat"))
     CreateFaqRequest.struct_class = Types::CreateFaqRequest
 
     CreateFaqResponse.add_member(:id, Shapes::ShapeRef.new(shape: FaqId, location_name: "Id"))
@@ -431,6 +439,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"))
@@ -476,6 +485,7 @@ module Aws::Kendra
     DescribeFaqResponse.add_member(:status, Shapes::ShapeRef.new(shape: FaqStatus, location_name: "Status"))
     DescribeFaqResponse.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
     DescribeFaqResponse.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "ErrorMessage"))
+    DescribeFaqResponse.add_member(:file_format, Shapes::ShapeRef.new(shape: FaqFileFormat, location_name: "FileFormat"))
     DescribeFaqResponse.struct_class = Types::DescribeFaqResponse
 
     DescribeIndexRequest.add_member(:id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "Id"))
@@ -548,6 +558,7 @@ module Aws::Kendra
     FacetList.member = Shapes::ShapeRef.new(shape: Facet)
 
     FacetResult.add_member(:document_attribute_key, Shapes::ShapeRef.new(shape: DocumentAttributeKey, location_name: "DocumentAttributeKey"))
+    FacetResult.add_member(:document_attribute_value_type, Shapes::ShapeRef.new(shape: DocumentAttributeValueType, location_name: "DocumentAttributeValueType"))
     FacetResult.add_member(:document_attribute_value_count_pairs, Shapes::ShapeRef.new(shape: DocumentAttributeValueCountPairList, location_name: "DocumentAttributeValueCountPairs"))
     FacetResult.struct_class = Types::FacetResult
 
@@ -561,6 +572,7 @@ module Aws::Kendra
     FaqSummary.add_member(:status, Shapes::ShapeRef.new(shape: FaqStatus, location_name: "Status"))
     FaqSummary.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt"))
     FaqSummary.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "UpdatedAt"))
+    FaqSummary.add_member(:file_format, Shapes::ShapeRef.new(shape: FaqFileFormat, location_name: "FileFormat"))
     FaqSummary.struct_class = Types::FaqSummary
 
     FaqSummaryItems.member = Shapes::ShapeRef.new(shape: FaqSummary)
@@ -662,6 +674,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"))
@@ -678,6 +691,7 @@ module Aws::Kendra
     QueryResultItem.add_member(:document_excerpt, Shapes::ShapeRef.new(shape: TextWithHighlights, location_name: "DocumentExcerpt"))
     QueryResultItem.add_member(:document_uri, Shapes::ShapeRef.new(shape: Url, location_name: "DocumentURI"))
     QueryResultItem.add_member(:document_attributes, Shapes::ShapeRef.new(shape: DocumentAttributeList, location_name: "DocumentAttributes"))
+    QueryResultItem.add_member(:score_attributes, Shapes::ShapeRef.new(shape: ScoreAttributes, location_name: "ScoreAttributes"))
     QueryResultItem.struct_class = Types::QueryResultItem
 
     QueryResultItemList.member = Shapes::ShapeRef.new(shape: QueryResultItem)
@@ -769,9 +783,13 @@ module Aws::Kendra
 
     SalesforceStandardObjectConfigurationList.member = Shapes::ShapeRef.new(shape: SalesforceStandardObjectConfiguration)
 
+    ScoreAttributes.add_member(:score_confidence, Shapes::ShapeRef.new(shape: ScoreConfidence, location_name: "ScoreConfidence"))
+    ScoreAttributes.struct_class = Types::ScoreAttributes
+
     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 +837,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

@@ -439,13 +439,13 @@ module Aws::Kendra
     #
     # @!attribute [rw] contains_all
     #   Returns true when a document contains all of the specified document
-    #   attributes. This filter is only appicable to `StringListValue`
+    #   attributes. This filter is only applicable to `StringListValue`
     #   metadata.
     #   @return [Types::DocumentAttribute]
     #
     # @!attribute [rw] contains_any
     #   Returns true when a document contains any of the specified document
-    #   attributes.This filter is only appicable to `StringListValue`
+    #   attributes. This filter is only applicable to `StringListValue`
     #   metadata.
     #   @return [Types::DocumentAttribute]
     #
@@ -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
@@ -1094,8 +1097,8 @@ module Aws::Kendra
     #   @return [String]
     #
     # @!attribute [rw] configuration
-    #   The connector configuration information that is required to access
-    #   the repository.
+    #   The data source connector configuration information that is required
+    #   to access the repository.
     #   @return [Types::DataSourceConfiguration]
     #
     # @!attribute [rw] description
@@ -1170,6 +1173,7 @@ module Aws::Kendra
     #             value: "TagValue", # required
     #           },
     #         ],
+    #         file_format: "CSV", # accepts CSV, CSV_WITH_HEADER, JSON
     #       }
     #
     # @!attribute [rw] index_id
@@ -1204,6 +1208,21 @@ module Aws::Kendra
     #   to resources.
     #   @return [Array<Types::Tag>]
     #
+    # @!attribute [rw] file_format
+    #   The format of the input file. You can choose between a basic CSV
+    #   format, a CSV format that includes customs attributes in a header,
+    #   and a JSON format that includes custom attributes.
+    #
+    #   The format must match the format of the file stored in the S3 bucket
+    #   identified in the `S3Path` parameter.
+    #
+    #   For more information, see [Adding questions and answers][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFaqRequest AWS API Documentation
     #
     class CreateFaqRequest < Struct.new(
@@ -1212,7 +1231,8 @@ module Aws::Kendra
       :description,
       :s3_path,
       :role_arn,
-      :tags)
+      :tags,
+      :file_format)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -1259,6 +1279,9 @@ module Aws::Kendra
     #   or proof of concept. Use `ENTERPRISE_EDITION` for your production
     #   databases. Once you set the edition for an index, it can't be
     #   changed.
+    #
+    #   The `Edition` parameter is optional. If you don't supply a value,
+    #   the default is `ENTERPRISE_EDITION`.
     #   @return [String]
     #
     # @!attribute [rw] role_arn
@@ -1387,6 +1410,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
@@ -1515,17 +1541,18 @@ module Aws::Kendra
     #       }
     #
     # @!attribute [rw] s3_configuration
-    #   Provides information to create a connector for a document repository
-    #   in an Amazon S3 bucket.
+    #   Provides information to create a data source connector for a
+    #   document repository in an Amazon S3 bucket.
     #   @return [Types::S3DataSourceConfiguration]
     #
     # @!attribute [rw] share_point_configuration
-    #   Provides information necessary to create a connector for a Microsoft
-    #   SharePoint site.
+    #   Provides information necessary to create a data source connector for
+    #   a Microsoft SharePoint site.
     #   @return [Types::SharePointConfiguration]
     #
     # @!attribute [rw] database_configuration
-    #   Provides information necessary to create a connector for a database.
+    #   Provides information necessary to create a data source connector for
+    #   a database.
     #   @return [Types::DatabaseConfiguration]
     #
     # @!attribute [rw] salesforce_configuration
@@ -1638,7 +1665,7 @@ module Aws::Kendra
     # @!attribute [rw] metrics
     #   Maps a batch delete document request to a specific data source sync
     #   job. This is optional and should only be supplied when documents are
-    #   deleted by a connector.
+    #   deleted by a data source connector.
     #   @return [Types::DataSourceSyncJobMetrics]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSyncJob AWS API Documentation
@@ -1685,7 +1712,7 @@ module Aws::Kendra
 
     # Maps a batch delete document request to a specific data source sync
     # job. This is optional and should only be supplied when documents are
-    # deleted by a connector.
+    # deleted by a data source connector.
     #
     # @!attribute [rw] documents_added
     #   The number of documents added from the data source up to now in the
@@ -1824,6 +1851,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 +1878,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 +1890,8 @@ module Aws::Kendra
       :connection_configuration,
       :vpc_configuration,
       :column_configuration,
-      :acl_configuration)
+      :acl_configuration,
+      :sql_configuration)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2097,6 +2133,10 @@ module Aws::Kendra
     #   the reason why the FAQ failed.
     #   @return [String]
     #
+    # @!attribute [rw] file_format
+    #   The file format used by the input files for the FAQ.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaqResponse AWS API Documentation
     #
     class DescribeFaqResponse < Struct.new(
@@ -2109,7 +2149,8 @@ module Aws::Kendra
       :s3_path,
       :status,
       :role_arn,
-      :error_message)
+      :error_message,
+      :file_format)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -2360,7 +2401,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 +2457,7 @@ module Aws::Kendra
     #           facetable: false,
     #           searchable: false,
     #           displayable: false,
+    #           sortable: false,
     #         },
     #       }
     #
@@ -2501,6 +2543,11 @@ module Aws::Kendra
     #   `DocumentAttributeKey` provided in the query.
     #   @return [String]
     #
+    # @!attribute [rw] document_attribute_value_type
+    #   The data type of the facet value. This is the same as the type
+    #   defined for the index field when it was created.
+    #   @return [String]
+    #
     # @!attribute [rw] document_attribute_value_count_pairs
     #   An array of key/value pairs, where the key is the value of the
     #   attribute and the count is the number of documents that share the
@@ -2511,6 +2558,7 @@ module Aws::Kendra
     #
     class FacetResult < Struct.new(
       :document_attribute_key,
+      :document_attribute_value_type,
       :document_attribute_value_count_pairs)
       SENSITIVE = []
       include Aws::Structure
@@ -2557,6 +2605,10 @@ module Aws::Kendra
     #   The UNIX datetime that the FAQ was last updated.
     #   @return [Time]
     #
+    # @!attribute [rw] file_format
+    #   The file type used to create the FAQ.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FaqSummary AWS API Documentation
     #
     class FaqSummary < Struct.new(
@@ -2564,7 +2616,8 @@ module Aws::Kendra
       :name,
       :status,
       :created_at,
-      :updated_at)
+      :updated_at,
+      :file_format)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -3180,6 +3233,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 +3289,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 +3310,8 @@ module Aws::Kendra
       :requested_document_attributes,
       :query_result_type_filter,
       :page_number,
-      :page_size)
+      :page_size,
+      :sorting_configuration)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -3263,8 +3332,9 @@ module Aws::Kendra
     #   @return [Array<Types::FacetResult>]
     #
     # @!attribute [rw] total_number_of_results
-    #   The number of items returned by the search. Use this to determine
-    #   when you have requested the last set of results.
+    #   The total number of items found by the search; however, you can only
+    #   retrieve up to 100 items. For example, if the search found 192
+    #   items, you can only retrieve the first 100 of the items.
     #   @return [Integer]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResult AWS API Documentation
@@ -3294,7 +3364,7 @@ module Aws::Kendra
     #   @return [String]
     #
     # @!attribute [rw] additional_attributes
-    #   One or more additional attribues associated with the query result.
+    #   One or more additional attributes associated with the query result.
     #   @return [Array<Types::AdditionalResultAttribute>]
     #
     # @!attribute [rw] document_id
@@ -3321,6 +3391,18 @@ module Aws::Kendra
     #   source URI (SourceUri) of the document.
     #   @return [Array<Types::DocumentAttribute>]
     #
+    # @!attribute [rw] score_attributes
+    #   Indicates the confidence that Amazon Kendra has that a result
+    #   matches the query that you provided. Each result is placed into a
+    #   bin that indicates the confidence, `VERY_HIGH`, `HIGH`, `MEDIUM` and
+    #   `LOW`. You can use the score to determine if a response meets the
+    #   confidence needed for your application.
+    #
+    #   The field is only set to `LOW` when the `Type` field is set to
+    #   `DOCUMENT` and Amazon Kendra is not confident that the result
+    #   matches the query.
+    #   @return [Types::ScoreAttributes]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResultItem AWS API Documentation
     #
     class QueryResultItem < Struct.new(
@@ -3331,7 +3413,8 @@ module Aws::Kendra
       :document_title,
       :document_excerpt,
       :document_uri,
-      :document_attributes)
+      :document_attributes,
+      :score_attributes)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -4046,6 +4129,21 @@ module Aws::Kendra
       include Aws::Structure
     end
 
+    # Provides a relative ranking that indicates how confident Amazon Kendra
+    # is that the response matches the query.
+    #
+    # @!attribute [rw] score_confidence
+    #   A relative ranking for how well the response matches the query.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ScoreAttributes AWS API Documentation
+    #
+    class ScoreAttributes < Struct.new(
+      :score_confidence)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Provides information about how a custom index field is used during a
     # search.
     #
@@ -4056,6 +4154,7 @@ module Aws::Kendra
     #         facetable: false,
     #         searchable: false,
     #         displayable: false,
+    #         sortable: false,
     #       }
     #
     # @!attribute [rw] facetable
@@ -4077,12 +4176,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 +4514,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 +4561,100 @@ 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.
+    #
+    # You can sort attributes of the following types.
+    #
+    # * Date value
+    #
+    # * Long value
+    #
+    # * String value
+    #
+    # You can't sort attributes of the following type.
+    #
+    # * String list value
+    #
+    # ^
+    #
+    # @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 for tables
+    #   and column names 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 set this field to `DOUBLE_QUOTES`.
+    #   @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 +5012,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 +5216,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.13.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-23 00:00:00.000000000 Z
+date: 2020-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core