aws-sdk-bedrockagent 1.27.0 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 123930db1958fdc1ef554a7f6a5c199d48ebd53aa493124c76dde6747bdde2cf
-  data.tar.gz: 5d98413d6c1b78f82cadae2ad4d6f324bc15d059e5e54f5a962068d2967f9c76
+  metadata.gz: fea6303d3387e69a1f99250cd033d77cc179e2d006bc4559b07fa55f61a88924
+  data.tar.gz: bc897341bc112f6dffedeb5ef2357f7f641a65e3609f6c2b00ec2436f7b77aed
 SHA512:
-  metadata.gz: fb3df45d383f6bdfa15830c242a4317ca09c2d04627e217f64f0e2902dea80da4f770025f72ee1f2de1111726cca49cdb10f062a3214acff7a55bd365a3d9a4d
-  data.tar.gz: 5cc559c55e1d50074fde2c21d1c99a9b3d571b98af09ad39fa025e261f75ef8f2a3d3bb42a4eac588ac51377fbffb7744a525c5f8b74ef6e98f275f566999945
+  metadata.gz: 3759c97ea057d80bc1c4201d02aaa2392bd6529b20a18968d3a65c79abc27c960ab9573a91b4aedb12ef3f999de552126a23816f8639665c9bdbbb2d9af828a9
+  data.tar.gz: 5d2b225aa3305a7358402ff9b6761349cb565d6794b142e4adf74e1fa51d4af24359ce96a1c06f7ceef12f31c6017a80047b17c55a795e903d36fd77acf1df86

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.28.0 (2024-10-01)
+------------------
+
+* Feature - This release adds support to stop an ongoing ingestion job using the StopIngestionJob API in Agents for Amazon Bedrock.
+
 1.27.0 (2024-09-24)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.27.0
+1.28.0

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

@@ -1719,11 +1719,11 @@ module Aws::BedrockAgent
       req.send_request(options)
     end
 
-    # Creates a knowledge base that contains data sources from which
-    # information can be queried and used by LLMs. To create a knowledge
-    # base, you must first set up your data sources and configure a
-    # supported vector store. For more information, see [Set up your data
-    # for ingestion][1].
+    # Creates a knowledge base. A knowledge base contains your data sources
+    # so that Large Language Models (LLMs) can use your data. To create a
+    # knowledge base, you must first set up your data sources and configure
+    # a supported vector store. For more information, see [Set up a
+    # knowledge base][1].
     #
     # <note markdown="1"> If you prefer to let Amazon Bedrock create and manage a vector store
     # for you in Amazon OpenSearch Service, use the console. For more
@@ -1759,7 +1759,7 @@ module Aws::BedrockAgent
     #
     #
     #
-    # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup.html
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowlege-base-prereq.html
     # [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-create
     # [3]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html
     # [4]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html
@@ -2886,8 +2886,7 @@ module Aws::BedrockAgent
     #   The unique identifier of the data source.
     #
     # @option params [required, String] :knowledge_base_id
-    #   The unique identifier of the knowledge base that the data source was
-    #   added to.
+    #   The unique identifier of the knowledge base for the data source.
     #
     # @return [Types::GetDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -3232,18 +3231,21 @@ module Aws::BedrockAgent
       req.send_request(options)
     end
 
-    # Gets information about a ingestion job, in which a data source is
-    # added to a knowledge base.
+    # Gets information about a data ingestion job. Data sources are ingested
+    # into your knowledge base so that Large Lanaguage Models (LLMs) can use
+    # your data.
     #
     # @option params [required, String] :data_source_id
-    #   The unique identifier of the data source in the ingestion job.
+    #   The unique identifier of the data source for the data ingestion job
+    #   you want to get information on.
     #
     # @option params [required, String] :ingestion_job_id
-    #   The unique identifier of the ingestion job.
+    #   The unique identifier of the data ingestion job you want to get
+    #   information on.
     #
     # @option params [required, String] :knowledge_base_id
-    #   The unique identifier of the knowledge base for which the ingestion
-    #   job applies.
+    #   The unique identifier of the knowledge base for the data ingestion job
+    #   you want to get information on.
     #
     # @return [Types::GetIngestionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -3273,7 +3275,7 @@ module Aws::BedrockAgent
     #   resp.ingestion_job.statistics.number_of_metadata_documents_scanned #=> Integer
     #   resp.ingestion_job.statistics.number_of_modified_documents_indexed #=> Integer
     #   resp.ingestion_job.statistics.number_of_new_documents_indexed #=> Integer
-    #   resp.ingestion_job.status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED"
+    #   resp.ingestion_job.status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED", "STOPPING", "STOPPED"
     #   resp.ingestion_job.updated_at #=> Time
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetIngestionJob AWS API Documentation
@@ -3288,8 +3290,8 @@ module Aws::BedrockAgent
     # Gets information about a knoweldge base.
     #
     # @option params [required, String] :knowledge_base_id
-    #   The unique identifier of the knowledge base for which to get
-    #   information.
+    #   The unique identifier of the knowledge base you want to get
+    #   information on.
     #
     # @return [Types::GetKnowledgeBaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -3932,18 +3934,18 @@ module Aws::BedrockAgent
       req.send_request(options)
     end
 
-    # Lists the ingestion jobs for a data source and information about each
-    # of them.
+    # Lists the data ingestion jobs for a data source. The list also
+    # includes information about each job.
     #
     # @option params [required, String] :data_source_id
-    #   The unique identifier of the data source for which to return ingestion
-    #   jobs.
+    #   The unique identifier of the data source for the list of data
+    #   ingestion jobs.
     #
     # @option params [Array<Types::IngestionJobFilter>] :filters
-    #   Contains a definition of a filter for which to filter the results.
+    #   Contains information about the filters for filtering the data.
     #
     # @option params [required, String] :knowledge_base_id
-    #   The unique identifier of the knowledge base for which to return
+    #   The unique identifier of the knowledge base for the list of data
     #   ingestion jobs.
     #
     # @option params [Integer] :max_results
@@ -3959,7 +3961,7 @@ module Aws::BedrockAgent
     #   results.
     #
     # @option params [Types::IngestionJobSortBy] :sort_by
-    #   Contains details about how to sort the results.
+    #   Contains details about how to sort the data.
     #
     # @return [Types::ListIngestionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -4003,7 +4005,7 @@ module Aws::BedrockAgent
     #   resp.ingestion_job_summaries[0].statistics.number_of_metadata_documents_scanned #=> Integer
     #   resp.ingestion_job_summaries[0].statistics.number_of_modified_documents_indexed #=> Integer
     #   resp.ingestion_job_summaries[0].statistics.number_of_new_documents_indexed #=> Integer
-    #   resp.ingestion_job_summaries[0].status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED"
+    #   resp.ingestion_job_summaries[0].status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED", "STOPPING", "STOPPED"
     #   resp.ingestion_job_summaries[0].updated_at #=> Time
     #   resp.next_token #=> String
     #
@@ -4016,8 +4018,8 @@ module Aws::BedrockAgent
       req.send_request(options)
     end
 
-    # Lists the knowledge bases in an account and information about each of
-    # them.
+    # Lists the knowledge bases in an account. The list also
+    # includesinformation about each knowledge base.
     #
     # @option params [Integer] :max_results
     #   The maximum number of results to return in the response. If the total
@@ -4228,8 +4230,8 @@ module Aws::BedrockAgent
       req.send_request(options)
     end
 
-    # Begins an ingestion job, in which a data source is added to a
-    # knowledge base.
+    # Begins a data ingestion job. Data sources are ingested into your
+    # knowledge base so that Large Language Models (LLMs) can use your data.
     #
     # @option params [String] :client_token
     #   A unique, case-sensitive identifier to ensure that the API request
@@ -4245,14 +4247,15 @@ module Aws::BedrockAgent
     #   [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
     #
     # @option params [required, String] :data_source_id
-    #   The unique identifier of the data source to ingest.
+    #   The unique identifier of the data source you want to ingest into your
+    #   knowledge base.
     #
     # @option params [String] :description
-    #   A description of the ingestion job.
+    #   A description of the data ingestion job.
     #
     # @option params [required, String] :knowledge_base_id
-    #   The unique identifier of the knowledge base to which to add the data
-    #   source.
+    #   The unique identifier of the knowledge base for the data ingestion
+    #   job.
     #
     # @return [Types::StartIngestionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -4283,7 +4286,7 @@ module Aws::BedrockAgent
     #   resp.ingestion_job.statistics.number_of_metadata_documents_scanned #=> Integer
     #   resp.ingestion_job.statistics.number_of_modified_documents_indexed #=> Integer
     #   resp.ingestion_job.statistics.number_of_new_documents_indexed #=> Integer
-    #   resp.ingestion_job.status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED"
+    #   resp.ingestion_job.status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED", "STOPPING", "STOPPED"
     #   resp.ingestion_job.updated_at #=> Time
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StartIngestionJob AWS API Documentation
@@ -4295,6 +4298,61 @@ module Aws::BedrockAgent
       req.send_request(options)
     end
 
+    # Stops a currently running data ingestion job. You can send a
+    # `StartIngestionJob` request again to ingest the rest of your data when
+    # you are ready.
+    #
+    # @option params [required, String] :data_source_id
+    #   The unique identifier of the data source for the data ingestion job
+    #   you want to stop.
+    #
+    # @option params [required, String] :ingestion_job_id
+    #   The unique identifier of the data ingestion job you want to stop.
+    #
+    # @option params [required, String] :knowledge_base_id
+    #   The unique identifier of the knowledge base for the data ingestion job
+    #   you want to stop.
+    #
+    # @return [Types::StopIngestionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::StopIngestionJobResponse#ingestion_job #ingestion_job} => Types::IngestionJob
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.stop_ingestion_job({
+    #     data_source_id: "Id", # required
+    #     ingestion_job_id: "Id", # required
+    #     knowledge_base_id: "Id", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.ingestion_job.data_source_id #=> String
+    #   resp.ingestion_job.description #=> String
+    #   resp.ingestion_job.failure_reasons #=> Array
+    #   resp.ingestion_job.failure_reasons[0] #=> String
+    #   resp.ingestion_job.ingestion_job_id #=> String
+    #   resp.ingestion_job.knowledge_base_id #=> String
+    #   resp.ingestion_job.started_at #=> Time
+    #   resp.ingestion_job.statistics.number_of_documents_deleted #=> Integer
+    #   resp.ingestion_job.statistics.number_of_documents_failed #=> Integer
+    #   resp.ingestion_job.statistics.number_of_documents_scanned #=> Integer
+    #   resp.ingestion_job.statistics.number_of_metadata_documents_modified #=> Integer
+    #   resp.ingestion_job.statistics.number_of_metadata_documents_scanned #=> Integer
+    #   resp.ingestion_job.statistics.number_of_modified_documents_indexed #=> Integer
+    #   resp.ingestion_job.statistics.number_of_new_documents_indexed #=> Integer
+    #   resp.ingestion_job.status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED", "STOPPING", "STOPPED"
+    #   resp.ingestion_job.updated_at #=> Time
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StopIngestionJob AWS API Documentation
+    #
+    # @overload stop_ingestion_job(params = {})
+    # @param [Hash] params ({})
+    def stop_ingestion_job(params = {}, options = {})
+      req = build_request(:stop_ingestion_job, params)
+      req.send_request(options)
+    end
+
     # Associate tags with a resource. For more information, see [Tagging
     # resources][1] in the Amazon Bedrock User Guide.
     #
@@ -5673,7 +5731,7 @@ module Aws::BedrockAgent
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-bedrockagent'
-      context[:gem_version] = '1.27.0'
+      context[:gem_version] = '1.28.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -407,6 +407,8 @@ module Aws::BedrockAgent
     StartIngestionJobRequest = Shapes::StructureShape.new(name: 'StartIngestionJobRequest')
     StartIngestionJobResponse = Shapes::StructureShape.new(name: 'StartIngestionJobResponse')
     StepType = Shapes::StringShape.new(name: 'StepType')
+    StopIngestionJobRequest = Shapes::StructureShape.new(name: 'StopIngestionJobRequest')
+    StopIngestionJobResponse = Shapes::StructureShape.new(name: 'StopIngestionJobResponse')
     StopSequences = Shapes::ListShape.new(name: 'StopSequences')
     StorageConfiguration = Shapes::StructureShape.new(name: 'StorageConfiguration')
     StorageDays = Shapes::IntegerShape.new(name: 'StorageDays')
@@ -1748,6 +1750,14 @@ module Aws::BedrockAgent
     StartIngestionJobResponse.add_member(:ingestion_job, Shapes::ShapeRef.new(shape: IngestionJob, required: true, location_name: "ingestionJob"))
     StartIngestionJobResponse.struct_class = Types::StartIngestionJobResponse
 
+    StopIngestionJobRequest.add_member(:data_source_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "dataSourceId"))
+    StopIngestionJobRequest.add_member(:ingestion_job_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "ingestionJobId"))
+    StopIngestionJobRequest.add_member(:knowledge_base_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "knowledgeBaseId"))
+    StopIngestionJobRequest.struct_class = Types::StopIngestionJobRequest
+
+    StopIngestionJobResponse.add_member(:ingestion_job, Shapes::ShapeRef.new(shape: IngestionJob, required: true, location_name: "ingestionJob"))
+    StopIngestionJobResponse.struct_class = Types::StopIngestionJobResponse
+
     StopSequences.member = Shapes::ShapeRef.new(shape: String)
 
     StorageConfiguration.add_member(:mongo_db_atlas_configuration, Shapes::ShapeRef.new(shape: MongoDbAtlasConfiguration, location_name: "mongoDbAtlasConfiguration"))
@@ -2748,6 +2758,20 @@ module Aws::BedrockAgent
         o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
       end)
 
+      api.add_operation(:stop_ingestion_job, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "StopIngestionJob"
+        o.http_method = "POST"
+        o.http_request_uri = "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/{ingestionJobId}/stop"
+        o.input = Shapes::ShapeRef.new(shape: StopIngestionJobRequest)
+        o.output = Shapes::ShapeRef.new(shape: StopIngestionJobResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ConflictException)
+      end)
+
       api.add_operation(:tag_resource, Seahorse::Model::Operation.new.tap do |o|
         o.name = "TagResource"
         o.http_method = "POST"

data/lib/aws-sdk-bedrockagent/endpoints.rb

@@ -562,6 +562,17 @@ module Aws::BedrockAgent
       end
     end
 
+    class StopIngestionJob
+      def self.build(context)
+        Aws::BedrockAgent::EndpointParameters.new(
+          region: context.config.region,
+          use_dual_stack: context.config.use_dualstack_endpoint,
+          use_fips: context.config.use_fips_endpoint,
+          endpoint: context.config.regional_endpoint ? nil : context.config.endpoint.to_s,
+        )
+      end
+    end
+
     class TagResource
       def self.build(context)
         Aws::BedrockAgent::EndpointParameters.new(

data/lib/aws-sdk-bedrockagent/plugins/endpoints.rb

@@ -170,6 +170,8 @@ The endpoint provider used to resolve endpoints. Any object that responds to
             Aws::BedrockAgent::Endpoints::PrepareFlow.build(context)
           when :start_ingestion_job
             Aws::BedrockAgent::Endpoints::StartIngestionJob.build(context)
+          when :stop_ingestion_job
+            Aws::BedrockAgent::Endpoints::StopIngestionJob.build(context)
           when :tag_resource
             Aws::BedrockAgent::Endpoints::TagResource.build(context)
           when :untag_resource

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

@@ -3671,8 +3671,7 @@ module Aws::BedrockAgent
     #   @return [String]
     #
     # @!attribute [rw] knowledge_base_id
-    #   The unique identifier of the knowledge base that the data source was
-    #   added to.
+    #   The unique identifier of the knowledge base for the data source.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetDataSourceRequest AWS API Documentation
@@ -3953,16 +3952,18 @@ module Aws::BedrockAgent
     end
 
     # @!attribute [rw] data_source_id
-    #   The unique identifier of the data source in the ingestion job.
+    #   The unique identifier of the data source for the data ingestion job
+    #   you want to get information on.
     #   @return [String]
     #
     # @!attribute [rw] ingestion_job_id
-    #   The unique identifier of the ingestion job.
+    #   The unique identifier of the data ingestion job you want to get
+    #   information on.
     #   @return [String]
     #
     # @!attribute [rw] knowledge_base_id
-    #   The unique identifier of the knowledge base for which the ingestion
-    #   job applies.
+    #   The unique identifier of the knowledge base for the data ingestion
+    #   job you want to get information on.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetIngestionJobRequest AWS API Documentation
@@ -3976,7 +3977,7 @@ module Aws::BedrockAgent
     end
 
     # @!attribute [rw] ingestion_job
-    #   Contains details about the ingestion job.
+    #   Contains details about the data ingestion job.
     #   @return [Types::IngestionJob]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetIngestionJobResponse AWS API Documentation
@@ -3988,8 +3989,8 @@ module Aws::BedrockAgent
     end
 
     # @!attribute [rw] knowledge_base_id
-    #   The unique identifier of the knowledge base for which to get
-    #   information.
+    #   The unique identifier of the knowledge base you want to get
+    #   information on.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetKnowledgeBaseRequest AWS API Documentation
@@ -4212,8 +4213,9 @@ module Aws::BedrockAgent
       include Aws::Structure
     end
 
-    # Contains details about an ingestion job, which converts a data source
-    # to embeddings for a vector store in knowledge base.
+    # Contains details about a data ingestion job. Data sources are ingested
+    # into a knowledge base so that Large Language Models (LLMs) can use
+    # your data.
     #
     # This data type is used in the following API operations:
     #
@@ -4230,40 +4232,45 @@ module Aws::BedrockAgent
     # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJobs.html#API_agent_ListIngestionJobs_ResponseSyntax
     #
     # @!attribute [rw] data_source_id
-    #   The unique identifier of the ingested data source.
+    #   The unique identifier of the data source for the data ingestion job.
     #   @return [String]
     #
     # @!attribute [rw] description
-    #   The description of the ingestion job.
+    #   The description of the data ingestion job.
     #   @return [String]
     #
     # @!attribute [rw] failure_reasons
-    #   A list of reasons that the ingestion job failed.
+    #   A list of reasons that the data ingestion job failed.
     #   @return [Array<String>]
     #
     # @!attribute [rw] ingestion_job_id
-    #   The unique identifier of the ingestion job.
+    #   The unique identifier of the data ingestion job.
     #   @return [String]
     #
     # @!attribute [rw] knowledge_base_id
-    #   The unique identifier of the knowledge base to which the data source
-    #   is being added.
+    #   The unique identifier of the knowledge for the data ingestion job.
     #   @return [String]
     #
     # @!attribute [rw] started_at
-    #   The time at which the ingestion job started.
+    #   The time the data ingestion job started.
+    #
+    #   If you stop a data ingestion job, the `startedAt` time is the time
+    #   the job was started before the job was stopped.
     #   @return [Time]
     #
     # @!attribute [rw] statistics
-    #   Contains statistics about the ingestion job.
+    #   Contains statistics about the data ingestion job.
     #   @return [Types::IngestionJobStatistics]
     #
     # @!attribute [rw] status
-    #   The status of the ingestion job.
+    #   The status of the data ingestion job.
     #   @return [String]
     #
     # @!attribute [rw] updated_at
-    #   The time at which the ingestion job was last updated.
+    #   The time the data ingestion job was last updated.
+    #
+    #   If you stop a data ingestion job, the `updatedAt` time is the time
+    #   the job was stopped.
     #   @return [Time]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IngestionJob AWS API Documentation
@@ -4282,18 +4289,18 @@ module Aws::BedrockAgent
       include Aws::Structure
     end
 
-    # Defines a filter by which to filter the results.
+    # The definition of a filter to filter the data.
     #
     # @!attribute [rw] attribute
-    #   The attribute by which to filter the results.
+    #   The name of field or attribute to apply the filter.
     #   @return [String]
     #
     # @!attribute [rw] operator
-    #   The operation to carry out between the attribute and the values.
+    #   The operation to apply to the field or attribute.
     #   @return [String]
     #
     # @!attribute [rw] values
-    #   A list of values for the attribute.
+    #   A list of values that belong to the field or attribute.
     #   @return [Array<String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IngestionJobFilter AWS API Documentation
@@ -4306,14 +4313,14 @@ module Aws::BedrockAgent
       include Aws::Structure
     end
 
-    # Parameters by which to sort the results.
+    # The parameters of sorting the data.
     #
     # @!attribute [rw] attribute
-    #   The attribute by which to sort the results.
+    #   The name of field or attribute to apply sorting of data.
     #   @return [String]
     #
     # @!attribute [rw] order
-    #   The order by which to sort the results.
+    #   The order for sorting the data.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IngestionJobSortBy AWS API Documentation
@@ -4325,10 +4332,10 @@ module Aws::BedrockAgent
       include Aws::Structure
     end
 
-    # Contains the statistics for the ingestion job.
+    # Contains the statistics for the data ingestion job.
     #
     # @!attribute [rw] number_of_documents_deleted
-    #   The number of source documents that was deleted.
+    #   The number of source documents that were deleted.
     #   @return [Integer]
     #
     # @!attribute [rw] number_of_documents_failed
@@ -4373,39 +4380,39 @@ module Aws::BedrockAgent
       include Aws::Structure
     end
 
-    # Contains details about an ingestion job.
+    # Contains details about a data ingestion job.
     #
     # @!attribute [rw] data_source_id
-    #   The unique identifier of the data source in the ingestion job.
+    #   The unique identifier of the data source for the data ingestion job.
     #   @return [String]
     #
     # @!attribute [rw] description
-    #   The description of the ingestion job.
+    #   The description of the data ingestion job.
     #   @return [String]
     #
     # @!attribute [rw] ingestion_job_id
-    #   The unique identifier of the ingestion job.
+    #   The unique identifier of the data ingestion job.
     #   @return [String]
     #
     # @!attribute [rw] knowledge_base_id
-    #   The unique identifier of the knowledge base to which the data source
-    #   is added.
+    #   The unique identifier of the knowledge base for the data ingestion
+    #   job.
     #   @return [String]
     #
     # @!attribute [rw] started_at
-    #   The time at which the ingestion job was started.
+    #   The time the data ingestion job started.
     #   @return [Time]
     #
     # @!attribute [rw] statistics
-    #   Contains statistics for the ingestion job.
+    #   Contains statistics for the data ingestion job.
     #   @return [Types::IngestionJobStatistics]
     #
     # @!attribute [rw] status
-    #   The status of the ingestion job.
+    #   The status of the data ingestion job.
     #   @return [String]
     #
     # @!attribute [rw] updated_at
-    #   The time at which the ingestion job was last updated.
+    #   The time the data ingestion job was last updated.
     #   @return [Time]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IngestionJobSummary AWS API Documentation
@@ -4479,7 +4486,7 @@ module Aws::BedrockAgent
     # Contains information about a knowledge base.
     #
     # @!attribute [rw] created_at
-    #   The time at which the knowledge base was created.
+    #   The time the knowledge base was created.
     #   @return [Time]
     #
     # @!attribute [rw] description
@@ -4534,7 +4541,7 @@ module Aws::BedrockAgent
     #   @return [Types::StorageConfiguration]
     #
     # @!attribute [rw] updated_at
-    #   The time at which the knowledge base was last updated.
+    #   The time the knowledge base was last updated.
     #   @return [Time]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBase AWS API Documentation
@@ -4555,8 +4562,8 @@ module Aws::BedrockAgent
       include Aws::Structure
     end
 
-    # Contains details about the embeddings configuration of the knowledge
-    # base.
+    # Contains details about the vector embeddings configuration of the
+    # knowledge base.
     #
     # @!attribute [rw] type
     #   The type of data that the data source is converted into for the
@@ -4564,8 +4571,8 @@ module Aws::BedrockAgent
     #   @return [String]
     #
     # @!attribute [rw] vector_knowledge_base_configuration
-    #   Contains details about the embeddings model that'sused to convert
-    #   the data source.
+    #   Contains details about the model that's used to convert the data
+    #   source into vector embeddings.
     #   @return [Types::VectorKnowledgeBaseConfiguration]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBaseConfiguration AWS API Documentation
@@ -4629,7 +4636,7 @@ module Aws::BedrockAgent
     #   @return [String]
     #
     # @!attribute [rw] updated_at
-    #   The time at which the knowledge base was last updated.
+    #   The time the knowledge base was last updated.
     #   @return [Time]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBaseSummary AWS API Documentation
@@ -5137,16 +5144,16 @@ module Aws::BedrockAgent
     end
 
     # @!attribute [rw] data_source_id
-    #   The unique identifier of the data source for which to return
+    #   The unique identifier of the data source for the list of data
     #   ingestion jobs.
     #   @return [String]
     #
     # @!attribute [rw] filters
-    #   Contains a definition of a filter for which to filter the results.
+    #   Contains information about the filters for filtering the data.
     #   @return [Array<Types::IngestionJobFilter>]
     #
     # @!attribute [rw] knowledge_base_id
-    #   The unique identifier of the knowledge base for which to return
+    #   The unique identifier of the knowledge base for the list of data
     #   ingestion jobs.
     #   @return [String]
     #
@@ -5165,7 +5172,7 @@ module Aws::BedrockAgent
     #   @return [String]
     #
     # @!attribute [rw] sort_by
-    #   Contains details about how to sort the results.
+    #   Contains details about how to sort the data.
     #   @return [Types::IngestionJobSortBy]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListIngestionJobsRequest AWS API Documentation
@@ -5182,8 +5189,7 @@ module Aws::BedrockAgent
     end
 
     # @!attribute [rw] ingestion_job_summaries
-    #   A list of objects, each of which contains information about an
-    #   ingestion job.
+    #   A list of data ingestion jobs with information about each job.
     #   @return [Array<Types::IngestionJobSummary>]
     #
     # @!attribute [rw] next_token
@@ -5226,8 +5232,8 @@ module Aws::BedrockAgent
     end
 
     # @!attribute [rw] knowledge_base_summaries
-    #   A list of objects, each of which contains information about a
-    #   knowledge base.
+    #   A list of knowledge bases with information about each knowledge
+    #   base.
     #   @return [Array<Types::KnowledgeBaseSummary>]
     #
     # @!attribute [rw] next_token
@@ -6783,16 +6789,17 @@ module Aws::BedrockAgent
     #   @return [String]
     #
     # @!attribute [rw] data_source_id
-    #   The unique identifier of the data source to ingest.
+    #   The unique identifier of the data source you want to ingest into
+    #   your knowledge base.
     #   @return [String]
     #
     # @!attribute [rw] description
-    #   A description of the ingestion job.
+    #   A description of the data ingestion job.
     #   @return [String]
     #
     # @!attribute [rw] knowledge_base_id
-    #   The unique identifier of the knowledge base to which to add the data
-    #   source.
+    #   The unique identifier of the knowledge base for the data ingestion
+    #   job.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StartIngestionJobRequest AWS API Documentation
@@ -6807,7 +6814,7 @@ module Aws::BedrockAgent
     end
 
     # @!attribute [rw] ingestion_job
-    #   An object containing information about the ingestion job.
+    #   Contains information about the data ingestion job.
     #   @return [Types::IngestionJob]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StartIngestionJobResponse AWS API Documentation
@@ -6818,6 +6825,42 @@ module Aws::BedrockAgent
       include Aws::Structure
     end
 
+    # @!attribute [rw] data_source_id
+    #   The unique identifier of the data source for the data ingestion job
+    #   you want to stop.
+    #   @return [String]
+    #
+    # @!attribute [rw] ingestion_job_id
+    #   The unique identifier of the data ingestion job you want to stop.
+    #   @return [String]
+    #
+    # @!attribute [rw] knowledge_base_id
+    #   The unique identifier of the knowledge base for the data ingestion
+    #   job you want to stop.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StopIngestionJobRequest AWS API Documentation
+    #
+    class StopIngestionJobRequest < Struct.new(
+      :data_source_id,
+      :ingestion_job_id,
+      :knowledge_base_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] ingestion_job
+    #   Contains information about the stopped data ingestion job.
+    #   @return [Types::IngestionJob]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StopIngestionJobResponse AWS API Documentation
+    #
+    class StopIngestionJobResponse < Struct.new(
+      :ingestion_job)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains the storage configuration of the knowledge base.
     #
     # @!attribute [rw] mongo_db_atlas_configuration

data/lib/aws-sdk-bedrockagent.rb

@@ -54,7 +54,7 @@ module Aws::BedrockAgent
   autoload :EndpointProvider, 'aws-sdk-bedrockagent/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-bedrockagent/endpoints'
 
-  GEM_VERSION = '1.27.0'
+  GEM_VERSION = '1.28.0'
 
 end
 

data/sig/client.rbs

@@ -1215,6 +1215,18 @@ module Aws
                                ) -> _StartIngestionJobResponseSuccess
                              | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartIngestionJobResponseSuccess
 
+      interface _StopIngestionJobResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::StopIngestionJobResponse]
+        def ingestion_job: () -> Types::IngestionJob
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#stop_ingestion_job-instance_method
+      def stop_ingestion_job: (
+                                data_source_id: ::String,
+                                ingestion_job_id: ::String,
+                                knowledge_base_id: ::String
+                              ) -> _StopIngestionJobResponseSuccess
+                            | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StopIngestionJobResponseSuccess
+
       interface _TagResourceResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceResponse]
       end

data/sig/types.rbs

@@ -1036,7 +1036,7 @@ module Aws::BedrockAgent
       attr_accessor knowledge_base_id: ::String
       attr_accessor started_at: ::Time
       attr_accessor statistics: Types::IngestionJobStatistics
-      attr_accessor status: ("STARTING" | "IN_PROGRESS" | "COMPLETE" | "FAILED")
+      attr_accessor status: ("STARTING" | "IN_PROGRESS" | "COMPLETE" | "FAILED" | "STOPPING" | "STOPPED")
       attr_accessor updated_at: ::Time
       SENSITIVE: []
     end
@@ -1072,7 +1072,7 @@ module Aws::BedrockAgent
       attr_accessor knowledge_base_id: ::String
       attr_accessor started_at: ::Time
       attr_accessor statistics: Types::IngestionJobStatistics
-      attr_accessor status: ("STARTING" | "IN_PROGRESS" | "COMPLETE" | "FAILED")
+      attr_accessor status: ("STARTING" | "IN_PROGRESS" | "COMPLETE" | "FAILED" | "STOPPING" | "STOPPED")
       attr_accessor updated_at: ::Time
       SENSITIVE: []
     end
@@ -1678,6 +1678,18 @@ module Aws::BedrockAgent
       SENSITIVE: []
     end
 
+    class StopIngestionJobRequest
+      attr_accessor data_source_id: ::String
+      attr_accessor ingestion_job_id: ::String
+      attr_accessor knowledge_base_id: ::String
+      SENSITIVE: []
+    end
+
+    class StopIngestionJobResponse
+      attr_accessor ingestion_job: Types::IngestionJob
+      SENSITIVE: []
+    end
+
     class StorageConfiguration
       attr_accessor mongo_db_atlas_configuration: Types::MongoDbAtlasConfiguration
       attr_accessor opensearch_serverless_configuration: Types::OpenSearchServerlessConfiguration

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-bedrockagent
 version: !ruby/object:Gem::Version
-  version: 1.27.0
+  version: 1.28.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-24 00:00:00.000000000 Z
+date: 2024-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core