aws-sdk-kendra 1.25.0 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c24dd5b0c9a0dfa5191e12c22817095559fe1a55fe11686928bf467a6381fbb6
-  data.tar.gz: 508006e9c8c7e694b2df5ce300bcd1aae37007991db321cea131a6c3fffcb2de
+  metadata.gz: db6db0d7989bf395d9d66113616dd832292db250ceae884e79f1ff68fc72c2da
+  data.tar.gz: 5d5c1a752c7eb99a07c0c60f67b913244b2731f0301eb4918171af9bdbe95ba6
 SHA512:
-  metadata.gz: 2e608a2fc83b64fe26924fe29e0a9d8b96ee651ff9d8d5ed98e9e0151e980f669b819e7ebb3b09aa142f679ca541014c58342e7ede4fe90a8c37f4107c2304a6
-  data.tar.gz: 532b41df9199cd337fec526cff3bde4a8b6aca52bd9962ed4218d3532415779b8f356ae6b487240eaaae83eddbe16c75641cffb9648d7a38a2af109a3f19992e
+  metadata.gz: 3c11d993010e54b7ba55c7503fa00b331b0b34da815eac768955ec402bc436885327483dceac3b85a46da932002ad9be3049b3db2bac82eae20ed84900e5be53
+  data.tar.gz: 13d14d88704eb78936b534371ef132863b4db06403b68648b7e3a03a53da263a1a2e5641e6cc5d5678241270af4b94960de35301e5cfb0c1fc1f3062400f121a

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.26.0 (2021-06-09)
+------------------
+
+* Feature - AWS Kendra now supports checking document status.
+
 1.25.0 (2021-05-27)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.25.0
+1.26.0

data/lib/aws-sdk-kendra.rb

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

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

@@ -384,6 +384,85 @@ module Aws::Kendra
       req.send_request(options)
     end
 
+    # Returns the indexing status for one or more documents submitted with
+    # the [ BatchPutDocument][1] operation.
+    #
+    # When you use the `BatchPutDocument` operation, documents are indexed
+    # asynchronously. You can use the `BatchGetDocumentStatus` operation to
+    # get the current status of a list of documents so that you can
+    # determine if they have been successfully indexed.
+    #
+    # You can also use the `BatchGetDocumentStatus` operation to check the
+    # status of the [ BatchDeleteDocument][2] operation. When a document is
+    # deleted from the index, Amazon Kendra returns `NOT_FOUND` as the
+    # status.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html
+    # [2]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html
+    #
+    # @option params [required, String] :index_id
+    #   The identifier of the index to add documents to. The index ID is
+    #   returned by the [ CreateIndex ][1] operation.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html
+    #
+    # @option params [required, Array<Types::DocumentInfo>] :document_info_list
+    #   A list of `DocumentInfo` objects that identify the documents for which
+    #   to get the status. You identify the documents by their document ID and
+    #   optional attributes.
+    #
+    # @return [Types::BatchGetDocumentStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::BatchGetDocumentStatusResponse#errors #errors} => Array&lt;Types::BatchGetDocumentStatusResponseError&gt;
+    #   * {Types::BatchGetDocumentStatusResponse#document_status_list #document_status_list} => Array&lt;Types::Status&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.batch_get_document_status({
+    #     index_id: "IndexId", # required
+    #     document_info_list: [ # required
+    #       {
+    #         document_id: "DocumentId", # required
+    #         attributes: [
+    #           {
+    #             key: "DocumentAttributeKey", # required
+    #             value: { # required
+    #               string_value: "DocumentAttributeStringValue",
+    #               string_list_value: ["String"],
+    #               long_value: 1,
+    #               date_value: Time.now,
+    #             },
+    #           },
+    #         ],
+    #       },
+    #     ],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.errors #=> Array
+    #   resp.errors[0].document_id #=> String
+    #   resp.errors[0].error_code #=> String, one of "InternalError", "InvalidRequest"
+    #   resp.errors[0].error_message #=> String
+    #   resp.document_status_list #=> Array
+    #   resp.document_status_list[0].document_id #=> String
+    #   resp.document_status_list[0].document_status #=> String, one of "NOT_FOUND", "PROCESSING", "INDEXED", "UPDATED", "FAILED", "UPDATE_FAILED"
+    #   resp.document_status_list[0].failure_code #=> String
+    #   resp.document_status_list[0].failure_reason #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatus AWS API Documentation
+    #
+    # @overload batch_get_document_status(params = {})
+    # @param [Hash] params ({})
+    def batch_get_document_status(params = {}, options = {})
+      req = build_request(:batch_get_document_status, params)
+      req.send_request(options)
+    end
+
     # Adds one or more documents to an index.
     #
     # The `BatchPutDocument` operation enables you to ingest inline
@@ -3430,7 +3509,7 @@ module Aws::Kendra
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-kendra'
-      context[:gem_version] = '1.25.0'
+      context[:gem_version] = '1.26.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -27,6 +27,10 @@ module Aws::Kendra
     BatchDeleteDocumentResponse = Shapes::StructureShape.new(name: 'BatchDeleteDocumentResponse')
     BatchDeleteDocumentResponseFailedDocument = Shapes::StructureShape.new(name: 'BatchDeleteDocumentResponseFailedDocument')
     BatchDeleteDocumentResponseFailedDocuments = Shapes::ListShape.new(name: 'BatchDeleteDocumentResponseFailedDocuments')
+    BatchGetDocumentStatusRequest = Shapes::StructureShape.new(name: 'BatchGetDocumentStatusRequest')
+    BatchGetDocumentStatusResponse = Shapes::StructureShape.new(name: 'BatchGetDocumentStatusResponse')
+    BatchGetDocumentStatusResponseError = Shapes::StructureShape.new(name: 'BatchGetDocumentStatusResponseError')
+    BatchGetDocumentStatusResponseErrors = Shapes::ListShape.new(name: 'BatchGetDocumentStatusResponseErrors')
     BatchPutDocumentRequest = Shapes::StructureShape.new(name: 'BatchPutDocumentRequest')
     BatchPutDocumentResponse = Shapes::StructureShape.new(name: 'BatchPutDocumentResponse')
     BatchPutDocumentResponseFailedDocument = Shapes::StructureShape.new(name: 'BatchPutDocumentResponseFailedDocument')
@@ -131,6 +135,8 @@ module Aws::Kendra
     DocumentAttributeValueType = Shapes::StringShape.new(name: 'DocumentAttributeValueType')
     DocumentId = Shapes::StringShape.new(name: 'DocumentId')
     DocumentIdList = Shapes::ListShape.new(name: 'DocumentIdList')
+    DocumentInfo = Shapes::StructureShape.new(name: 'DocumentInfo')
+    DocumentInfoList = Shapes::ListShape.new(name: 'DocumentInfoList')
     DocumentList = Shapes::ListShape.new(name: 'DocumentList')
     DocumentMetadataBoolean = Shapes::BooleanShape.new(name: 'DocumentMetadataBoolean')
     DocumentMetadataConfiguration = Shapes::StructureShape.new(name: 'DocumentMetadataConfiguration')
@@ -138,6 +144,8 @@ module Aws::Kendra
     DocumentMetadataConfigurationName = Shapes::StringShape.new(name: 'DocumentMetadataConfigurationName')
     DocumentRelevanceConfiguration = Shapes::StructureShape.new(name: 'DocumentRelevanceConfiguration')
     DocumentRelevanceOverrideConfigurationList = Shapes::ListShape.new(name: 'DocumentRelevanceOverrideConfigurationList')
+    DocumentStatus = Shapes::StringShape.new(name: 'DocumentStatus')
+    DocumentStatusList = Shapes::ListShape.new(name: 'DocumentStatusList')
     DocumentsMetadataConfiguration = Shapes::StructureShape.new(name: 'DocumentsMetadataConfiguration')
     Duration = Shapes::StringShape.new(name: 'Duration')
     ErrorCode = Shapes::StringShape.new(name: 'ErrorCode')
@@ -290,6 +298,7 @@ module Aws::Kendra
     SqlConfiguration = Shapes::StructureShape.new(name: 'SqlConfiguration')
     StartDataSourceSyncJobRequest = Shapes::StructureShape.new(name: 'StartDataSourceSyncJobRequest')
     StartDataSourceSyncJobResponse = Shapes::StructureShape.new(name: 'StartDataSourceSyncJobResponse')
+    Status = Shapes::StructureShape.new(name: 'Status')
     StopDataSourceSyncJobRequest = Shapes::StructureShape.new(name: 'StopDataSourceSyncJobRequest')
     StorageCapacityUnit = Shapes::IntegerShape.new(name: 'StorageCapacityUnit')
     String = Shapes::StringShape.new(name: 'String')
@@ -392,6 +401,21 @@ module Aws::Kendra
 
     BatchDeleteDocumentResponseFailedDocuments.member = Shapes::ShapeRef.new(shape: BatchDeleteDocumentResponseFailedDocument)
 
+    BatchGetDocumentStatusRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
+    BatchGetDocumentStatusRequest.add_member(:document_info_list, Shapes::ShapeRef.new(shape: DocumentInfoList, required: true, location_name: "DocumentInfoList"))
+    BatchGetDocumentStatusRequest.struct_class = Types::BatchGetDocumentStatusRequest
+
+    BatchGetDocumentStatusResponse.add_member(:errors, Shapes::ShapeRef.new(shape: BatchGetDocumentStatusResponseErrors, location_name: "Errors"))
+    BatchGetDocumentStatusResponse.add_member(:document_status_list, Shapes::ShapeRef.new(shape: DocumentStatusList, location_name: "DocumentStatusList"))
+    BatchGetDocumentStatusResponse.struct_class = Types::BatchGetDocumentStatusResponse
+
+    BatchGetDocumentStatusResponseError.add_member(:document_id, Shapes::ShapeRef.new(shape: DocumentId, location_name: "DocumentId"))
+    BatchGetDocumentStatusResponseError.add_member(:error_code, Shapes::ShapeRef.new(shape: ErrorCode, location_name: "ErrorCode"))
+    BatchGetDocumentStatusResponseError.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "ErrorMessage"))
+    BatchGetDocumentStatusResponseError.struct_class = Types::BatchGetDocumentStatusResponseError
+
+    BatchGetDocumentStatusResponseErrors.member = Shapes::ShapeRef.new(shape: BatchGetDocumentStatusResponseError)
+
     BatchPutDocumentRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
     BatchPutDocumentRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
     BatchPutDocumentRequest.add_member(:documents, Shapes::ShapeRef.new(shape: DocumentList, required: true, location_name: "Documents"))
@@ -785,6 +809,12 @@ module Aws::Kendra
 
     DocumentIdList.member = Shapes::ShapeRef.new(shape: DocumentId)
 
+    DocumentInfo.add_member(:document_id, Shapes::ShapeRef.new(shape: DocumentId, required: true, location_name: "DocumentId"))
+    DocumentInfo.add_member(:attributes, Shapes::ShapeRef.new(shape: DocumentAttributeList, location_name: "Attributes"))
+    DocumentInfo.struct_class = Types::DocumentInfo
+
+    DocumentInfoList.member = Shapes::ShapeRef.new(shape: DocumentInfo)
+
     DocumentList.member = Shapes::ShapeRef.new(shape: Document)
 
     DocumentMetadataConfiguration.add_member(:name, Shapes::ShapeRef.new(shape: DocumentMetadataConfigurationName, required: true, location_name: "Name"))
@@ -801,6 +831,8 @@ module Aws::Kendra
 
     DocumentRelevanceOverrideConfigurationList.member = Shapes::ShapeRef.new(shape: DocumentRelevanceConfiguration)
 
+    DocumentStatusList.member = Shapes::ShapeRef.new(shape: Status)
+
     DocumentsMetadataConfiguration.add_member(:s3_prefix, Shapes::ShapeRef.new(shape: S3ObjectKey, location_name: "S3Prefix"))
     DocumentsMetadataConfiguration.struct_class = Types::DocumentsMetadataConfiguration
 
@@ -1178,6 +1210,12 @@ module Aws::Kendra
     StartDataSourceSyncJobResponse.add_member(:execution_id, Shapes::ShapeRef.new(shape: String, location_name: "ExecutionId"))
     StartDataSourceSyncJobResponse.struct_class = Types::StartDataSourceSyncJobResponse
 
+    Status.add_member(:document_id, Shapes::ShapeRef.new(shape: DocumentId, location_name: "DocumentId"))
+    Status.add_member(:document_status, Shapes::ShapeRef.new(shape: DocumentStatus, location_name: "DocumentStatus"))
+    Status.add_member(:failure_code, Shapes::ShapeRef.new(shape: String, location_name: "FailureCode"))
+    Status.add_member(:failure_reason, Shapes::ShapeRef.new(shape: String, location_name: "FailureReason"))
+    Status.struct_class = Types::Status
+
     StopDataSourceSyncJobRequest.add_member(:id, Shapes::ShapeRef.new(shape: DataSourceId, required: true, location_name: "Id"))
     StopDataSourceSyncJobRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
     StopDataSourceSyncJobRequest.struct_class = Types::StopDataSourceSyncJobRequest
@@ -1345,6 +1383,20 @@ module Aws::Kendra
         o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
       end)
 
+      api.add_operation(:batch_get_document_status, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "BatchGetDocumentStatus"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: BatchGetDocumentStatusRequest)
+        o.output = Shapes::ShapeRef.new(shape: BatchGetDocumentStatusResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: ConflictException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+      end)
+
       api.add_operation(:batch_put_document, Seahorse::Model::Operation.new.tap do |o|
         o.name = "BatchPutDocument"
         o.http_method = "POST"

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

@@ -568,6 +568,103 @@ module Aws::Kendra
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass BatchGetDocumentStatusRequest
+    #   data as a hash:
+    #
+    #       {
+    #         index_id: "IndexId", # required
+    #         document_info_list: [ # required
+    #           {
+    #             document_id: "DocumentId", # required
+    #             attributes: [
+    #               {
+    #                 key: "DocumentAttributeKey", # required
+    #                 value: { # required
+    #                   string_value: "DocumentAttributeStringValue",
+    #                   string_list_value: ["String"],
+    #                   long_value: 1,
+    #                   date_value: Time.now,
+    #                 },
+    #               },
+    #             ],
+    #           },
+    #         ],
+    #       }
+    #
+    # @!attribute [rw] index_id
+    #   The identifier of the index to add documents to. The index ID is
+    #   returned by the [ CreateIndex ][1] operation.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html
+    #   @return [String]
+    #
+    # @!attribute [rw] document_info_list
+    #   A list of `DocumentInfo` objects that identify the documents for
+    #   which to get the status. You identify the documents by their
+    #   document ID and optional attributes.
+    #   @return [Array<Types::DocumentInfo>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatusRequest AWS API Documentation
+    #
+    class BatchGetDocumentStatusRequest < Struct.new(
+      :index_id,
+      :document_info_list)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] errors
+    #   A list of documents that Amazon Kendra couldn't get the status for.
+    #   The list includes the ID of the document and the reason that the
+    #   status couldn't be found.
+    #   @return [Array<Types::BatchGetDocumentStatusResponseError>]
+    #
+    # @!attribute [rw] document_status_list
+    #   The status of documents. The status indicates if the document is
+    #   waiting to be indexed, is in the process of indexing, has completed
+    #   indexing, or failed indexing. If a document failed indexing, the
+    #   status provides the reason why.
+    #   @return [Array<Types::Status>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatusResponse AWS API Documentation
+    #
+    class BatchGetDocumentStatusResponse < Struct.new(
+      :errors,
+      :document_status_list)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Provides a response when the status of a document could not be
+    # retrieved.
+    #
+    # @!attribute [rw] document_id
+    #   The unique identifier of the document whose status could not be
+    #   retrieved.
+    #   @return [String]
+    #
+    # @!attribute [rw] error_code
+    #   Indicates the source of the error.
+    #   @return [String]
+    #
+    # @!attribute [rw] error_message
+    #   States that the API could not get the status of a document. This
+    #   could be because the request is not valid or there is a system
+    #   error.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchGetDocumentStatusResponseError AWS API Documentation
+    #
+    class BatchGetDocumentStatusResponseError < Struct.new(
+      :document_id,
+      :error_code,
+      :error_message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass BatchPutDocumentRequest
     #   data as a hash:
     #
@@ -3739,6 +3836,11 @@ module Aws::Kendra
     #
     # @!attribute [rw] date_value
     #   A date expressed as an ISO 8601 string.
+    #
+    #   It is important for the time zone to be included in the ISO 8601
+    #   date-time format. For example, 20120325T123010+01:00 is the ISO 8601
+    #   date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in
+    #   Central European Time.
     #   @return [Time]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentAttributeValue AWS API Documentation
@@ -3773,6 +3875,61 @@ module Aws::Kendra
       include Aws::Structure
     end
 
+    # Identifies a document for which to retrieve status information
+    #
+    # @note When making an API call, you may pass DocumentInfo
+    #   data as a hash:
+    #
+    #       {
+    #         document_id: "DocumentId", # required
+    #         attributes: [
+    #           {
+    #             key: "DocumentAttributeKey", # required
+    #             value: { # required
+    #               string_value: "DocumentAttributeStringValue",
+    #               string_list_value: ["String"],
+    #               long_value: 1,
+    #               date_value: Time.now,
+    #             },
+    #           },
+    #         ],
+    #       }
+    #
+    # @!attribute [rw] document_id
+    #   The unique identifier of the document.
+    #   @return [String]
+    #
+    # @!attribute [rw] attributes
+    #   Attributes that identify a specific version of a document to check.
+    #
+    #   The only valid attributes are:
+    #
+    #   * version
+    #
+    #   * datasourceId
+    #
+    #   * jobExecutionId
+    #
+    #   The attributes follow these rules:
+    #
+    #   * `dataSourceId` and `jobExecutionId` must be used together.
+    #
+    #   * `version` is ignored if `dataSourceId` and `jobExecutionId` are
+    #     not provided.
+    #
+    #   * If `dataSourceId` and `jobExecutionId` are provided, but `version`
+    #     is not, the version defaults to "0".
+    #   @return [Array<Types::DocumentAttribute>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentInfo AWS API Documentation
+    #
+    class DocumentInfo < Struct.new(
+      :document_id,
+      :attributes)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Specifies the properties of a custom index field.
     #
     # @note When making an API call, you may pass DocumentMetadataConfiguration
@@ -6649,6 +6806,41 @@ module Aws::Kendra
       include Aws::Structure
     end
 
+    # Provides information about the status of documents submitted for
+    # indexing.
+    #
+    # @!attribute [rw] document_id
+    #   The unique identifier of the document.
+    #   @return [String]
+    #
+    # @!attribute [rw] document_status
+    #   The current status of a document.
+    #
+    #   If the document was submitted for deletion, the status is
+    #   `NOT_FOUND` after the document is deleted.
+    #   @return [String]
+    #
+    # @!attribute [rw] failure_code
+    #   Indicates the source of the error.
+    #   @return [String]
+    #
+    # @!attribute [rw] failure_reason
+    #   Provides detailed information about why the document couldn't be
+    #   indexed. Use this information to correct the error before you
+    #   resubmit the document for indexing.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Status AWS API Documentation
+    #
+    class Status < Struct.new(
+      :document_id,
+      :document_status,
+      :failure_code,
+      :failure_reason)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass StopDataSourceSyncJobRequest
     #   data as a hash:
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-kendra
 version: !ruby/object:Gem::Version
-  version: 1.25.0
+  version: 1.26.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-27 00:00:00.000000000 Z
+date: 2021-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core