aws-sdk-bedrockagent 1.26.0 → 1.28.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 27c87e7c8498a571482500a5b7fd5a0e93660a71591e0fb1c453a11878603551
4
- data.tar.gz: 8fcf226071415796554e2c17edfdb0b88e8b136a170d00ceeb0dfcad568e86ac
3
+ metadata.gz: fea6303d3387e69a1f99250cd033d77cc179e2d006bc4559b07fa55f61a88924
4
+ data.tar.gz: bc897341bc112f6dffedeb5ef2357f7f641a65e3609f6c2b00ec2436f7b77aed
5
5
  SHA512:
6
- metadata.gz: 67f38d43ab3452a9801ac2cb5ab6a459acdd1539e37d40197f5ed9ea4324051af7454b3582108ce861d411b2591b23524278c8e33e265e455daffebabc36e578
7
- data.tar.gz: b1433eae81c3985a0bebc37c170fe2de4f699c26a8dcb4c4bf350443b38539e3457061827c194e5a1563108c17fc0c0f31e5555b18aaa6de9b5e972791dbb7e3
6
+ metadata.gz: 3759c97ea057d80bc1c4201d02aaa2392bd6529b20a18968d3a65c79abc27c960ab9573a91b4aedb12ef3f999de552126a23816f8639665c9bdbbb2d9af828a9
7
+ data.tar.gz: 5d2b225aa3305a7358402ff9b6761349cb565d6794b142e4adf74e1fa51d4af24359ce96a1c06f7ceef12f31c6017a80047b17c55a795e903d36fd77acf1df86
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.28.0 (2024-10-01)
5
+ ------------------
6
+
7
+ * Feature - This release adds support to stop an ongoing ingestion job using the StopIngestionJob API in Agents for Amazon Bedrock.
8
+
9
+ 1.27.0 (2024-09-24)
10
+ ------------------
11
+
12
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
13
+
4
14
  1.26.0 (2024-09-23)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.26.0
1
+ 1.28.0
@@ -36,8 +36,6 @@ require 'aws-sdk-core/plugins/telemetry.rb'
36
36
  require 'aws-sdk-core/plugins/sign.rb'
37
37
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
38
38
 
39
- Aws::Plugins::GlobalConfiguration.add_identifier(:bedrockagent)
40
-
41
39
  module Aws::BedrockAgent
42
40
  # An API client for BedrockAgent. To construct a client, you need to configure a `:region` and `:credentials`.
43
41
  #
@@ -1721,11 +1719,11 @@ module Aws::BedrockAgent
1721
1719
  req.send_request(options)
1722
1720
  end
1723
1721
 
1724
- # Creates a knowledge base that contains data sources from which
1725
- # information can be queried and used by LLMs. To create a knowledge
1726
- # base, you must first set up your data sources and configure a
1727
- # supported vector store. For more information, see [Set up your data
1728
- # for ingestion][1].
1722
+ # Creates a knowledge base. A knowledge base contains your data sources
1723
+ # so that Large Language Models (LLMs) can use your data. To create a
1724
+ # knowledge base, you must first set up your data sources and configure
1725
+ # a supported vector store. For more information, see [Set up a
1726
+ # knowledge base][1].
1729
1727
  #
1730
1728
  # <note markdown="1"> If you prefer to let Amazon Bedrock create and manage a vector store
1731
1729
  # for you in Amazon OpenSearch Service, use the console. For more
@@ -1761,7 +1759,7 @@ module Aws::BedrockAgent
1761
1759
  #
1762
1760
  #
1763
1761
  #
1764
- # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup.html
1762
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowlege-base-prereq.html
1765
1763
  # [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-create
1766
1764
  # [3]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html
1767
1765
  # [4]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html
@@ -2888,8 +2886,7 @@ module Aws::BedrockAgent
2888
2886
  # The unique identifier of the data source.
2889
2887
  #
2890
2888
  # @option params [required, String] :knowledge_base_id
2891
- # The unique identifier of the knowledge base that the data source was
2892
- # added to.
2889
+ # The unique identifier of the knowledge base for the data source.
2893
2890
  #
2894
2891
  # @return [Types::GetDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2895
2892
  #
@@ -3234,18 +3231,21 @@ module Aws::BedrockAgent
3234
3231
  req.send_request(options)
3235
3232
  end
3236
3233
 
3237
- # Gets information about a ingestion job, in which a data source is
3238
- # added to a knowledge base.
3234
+ # Gets information about a data ingestion job. Data sources are ingested
3235
+ # into your knowledge base so that Large Lanaguage Models (LLMs) can use
3236
+ # your data.
3239
3237
  #
3240
3238
  # @option params [required, String] :data_source_id
3241
- # The unique identifier of the data source in the ingestion job.
3239
+ # The unique identifier of the data source for the data ingestion job
3240
+ # you want to get information on.
3242
3241
  #
3243
3242
  # @option params [required, String] :ingestion_job_id
3244
- # The unique identifier of the ingestion job.
3243
+ # The unique identifier of the data ingestion job you want to get
3244
+ # information on.
3245
3245
  #
3246
3246
  # @option params [required, String] :knowledge_base_id
3247
- # The unique identifier of the knowledge base for which the ingestion
3248
- # job applies.
3247
+ # The unique identifier of the knowledge base for the data ingestion job
3248
+ # you want to get information on.
3249
3249
  #
3250
3250
  # @return [Types::GetIngestionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3251
3251
  #
@@ -3275,7 +3275,7 @@ module Aws::BedrockAgent
3275
3275
  # resp.ingestion_job.statistics.number_of_metadata_documents_scanned #=> Integer
3276
3276
  # resp.ingestion_job.statistics.number_of_modified_documents_indexed #=> Integer
3277
3277
  # resp.ingestion_job.statistics.number_of_new_documents_indexed #=> Integer
3278
- # resp.ingestion_job.status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED"
3278
+ # resp.ingestion_job.status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED", "STOPPING", "STOPPED"
3279
3279
  # resp.ingestion_job.updated_at #=> Time
3280
3280
  #
3281
3281
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetIngestionJob AWS API Documentation
@@ -3290,8 +3290,8 @@ module Aws::BedrockAgent
3290
3290
  # Gets information about a knoweldge base.
3291
3291
  #
3292
3292
  # @option params [required, String] :knowledge_base_id
3293
- # The unique identifier of the knowledge base for which to get
3294
- # information.
3293
+ # The unique identifier of the knowledge base you want to get
3294
+ # information on.
3295
3295
  #
3296
3296
  # @return [Types::GetKnowledgeBaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3297
3297
  #
@@ -3934,18 +3934,18 @@ module Aws::BedrockAgent
3934
3934
  req.send_request(options)
3935
3935
  end
3936
3936
 
3937
- # Lists the ingestion jobs for a data source and information about each
3938
- # of them.
3937
+ # Lists the data ingestion jobs for a data source. The list also
3938
+ # includes information about each job.
3939
3939
  #
3940
3940
  # @option params [required, String] :data_source_id
3941
- # The unique identifier of the data source for which to return ingestion
3942
- # jobs.
3941
+ # The unique identifier of the data source for the list of data
3942
+ # ingestion jobs.
3943
3943
  #
3944
3944
  # @option params [Array<Types::IngestionJobFilter>] :filters
3945
- # Contains a definition of a filter for which to filter the results.
3945
+ # Contains information about the filters for filtering the data.
3946
3946
  #
3947
3947
  # @option params [required, String] :knowledge_base_id
3948
- # The unique identifier of the knowledge base for which to return
3948
+ # The unique identifier of the knowledge base for the list of data
3949
3949
  # ingestion jobs.
3950
3950
  #
3951
3951
  # @option params [Integer] :max_results
@@ -3961,7 +3961,7 @@ module Aws::BedrockAgent
3961
3961
  # results.
3962
3962
  #
3963
3963
  # @option params [Types::IngestionJobSortBy] :sort_by
3964
- # Contains details about how to sort the results.
3964
+ # Contains details about how to sort the data.
3965
3965
  #
3966
3966
  # @return [Types::ListIngestionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3967
3967
  #
@@ -4005,7 +4005,7 @@ module Aws::BedrockAgent
4005
4005
  # resp.ingestion_job_summaries[0].statistics.number_of_metadata_documents_scanned #=> Integer
4006
4006
  # resp.ingestion_job_summaries[0].statistics.number_of_modified_documents_indexed #=> Integer
4007
4007
  # resp.ingestion_job_summaries[0].statistics.number_of_new_documents_indexed #=> Integer
4008
- # resp.ingestion_job_summaries[0].status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED"
4008
+ # resp.ingestion_job_summaries[0].status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED", "STOPPING", "STOPPED"
4009
4009
  # resp.ingestion_job_summaries[0].updated_at #=> Time
4010
4010
  # resp.next_token #=> String
4011
4011
  #
@@ -4018,8 +4018,8 @@ module Aws::BedrockAgent
4018
4018
  req.send_request(options)
4019
4019
  end
4020
4020
 
4021
- # Lists the knowledge bases in an account and information about each of
4022
- # them.
4021
+ # Lists the knowledge bases in an account. The list also
4022
+ # includesinformation about each knowledge base.
4023
4023
  #
4024
4024
  # @option params [Integer] :max_results
4025
4025
  # The maximum number of results to return in the response. If the total
@@ -4230,8 +4230,8 @@ module Aws::BedrockAgent
4230
4230
  req.send_request(options)
4231
4231
  end
4232
4232
 
4233
- # Begins an ingestion job, in which a data source is added to a
4234
- # knowledge base.
4233
+ # Begins a data ingestion job. Data sources are ingested into your
4234
+ # knowledge base so that Large Language Models (LLMs) can use your data.
4235
4235
  #
4236
4236
  # @option params [String] :client_token
4237
4237
  # A unique, case-sensitive identifier to ensure that the API request
@@ -4247,14 +4247,15 @@ module Aws::BedrockAgent
4247
4247
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
4248
4248
  #
4249
4249
  # @option params [required, String] :data_source_id
4250
- # The unique identifier of the data source to ingest.
4250
+ # The unique identifier of the data source you want to ingest into your
4251
+ # knowledge base.
4251
4252
  #
4252
4253
  # @option params [String] :description
4253
- # A description of the ingestion job.
4254
+ # A description of the data ingestion job.
4254
4255
  #
4255
4256
  # @option params [required, String] :knowledge_base_id
4256
- # The unique identifier of the knowledge base to which to add the data
4257
- # source.
4257
+ # The unique identifier of the knowledge base for the data ingestion
4258
+ # job.
4258
4259
  #
4259
4260
  # @return [Types::StartIngestionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4260
4261
  #
@@ -4285,7 +4286,7 @@ module Aws::BedrockAgent
4285
4286
  # resp.ingestion_job.statistics.number_of_metadata_documents_scanned #=> Integer
4286
4287
  # resp.ingestion_job.statistics.number_of_modified_documents_indexed #=> Integer
4287
4288
  # resp.ingestion_job.statistics.number_of_new_documents_indexed #=> Integer
4288
- # resp.ingestion_job.status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED"
4289
+ # resp.ingestion_job.status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED", "STOPPING", "STOPPED"
4289
4290
  # resp.ingestion_job.updated_at #=> Time
4290
4291
  #
4291
4292
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StartIngestionJob AWS API Documentation
@@ -4297,6 +4298,61 @@ module Aws::BedrockAgent
4297
4298
  req.send_request(options)
4298
4299
  end
4299
4300
 
4301
+ # Stops a currently running data ingestion job. You can send a
4302
+ # `StartIngestionJob` request again to ingest the rest of your data when
4303
+ # you are ready.
4304
+ #
4305
+ # @option params [required, String] :data_source_id
4306
+ # The unique identifier of the data source for the data ingestion job
4307
+ # you want to stop.
4308
+ #
4309
+ # @option params [required, String] :ingestion_job_id
4310
+ # The unique identifier of the data ingestion job you want to stop.
4311
+ #
4312
+ # @option params [required, String] :knowledge_base_id
4313
+ # The unique identifier of the knowledge base for the data ingestion job
4314
+ # you want to stop.
4315
+ #
4316
+ # @return [Types::StopIngestionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4317
+ #
4318
+ # * {Types::StopIngestionJobResponse#ingestion_job #ingestion_job} => Types::IngestionJob
4319
+ #
4320
+ # @example Request syntax with placeholder values
4321
+ #
4322
+ # resp = client.stop_ingestion_job({
4323
+ # data_source_id: "Id", # required
4324
+ # ingestion_job_id: "Id", # required
4325
+ # knowledge_base_id: "Id", # required
4326
+ # })
4327
+ #
4328
+ # @example Response structure
4329
+ #
4330
+ # resp.ingestion_job.data_source_id #=> String
4331
+ # resp.ingestion_job.description #=> String
4332
+ # resp.ingestion_job.failure_reasons #=> Array
4333
+ # resp.ingestion_job.failure_reasons[0] #=> String
4334
+ # resp.ingestion_job.ingestion_job_id #=> String
4335
+ # resp.ingestion_job.knowledge_base_id #=> String
4336
+ # resp.ingestion_job.started_at #=> Time
4337
+ # resp.ingestion_job.statistics.number_of_documents_deleted #=> Integer
4338
+ # resp.ingestion_job.statistics.number_of_documents_failed #=> Integer
4339
+ # resp.ingestion_job.statistics.number_of_documents_scanned #=> Integer
4340
+ # resp.ingestion_job.statistics.number_of_metadata_documents_modified #=> Integer
4341
+ # resp.ingestion_job.statistics.number_of_metadata_documents_scanned #=> Integer
4342
+ # resp.ingestion_job.statistics.number_of_modified_documents_indexed #=> Integer
4343
+ # resp.ingestion_job.statistics.number_of_new_documents_indexed #=> Integer
4344
+ # resp.ingestion_job.status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED", "STOPPING", "STOPPED"
4345
+ # resp.ingestion_job.updated_at #=> Time
4346
+ #
4347
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StopIngestionJob AWS API Documentation
4348
+ #
4349
+ # @overload stop_ingestion_job(params = {})
4350
+ # @param [Hash] params ({})
4351
+ def stop_ingestion_job(params = {}, options = {})
4352
+ req = build_request(:stop_ingestion_job, params)
4353
+ req.send_request(options)
4354
+ end
4355
+
4300
4356
  # Associate tags with a resource. For more information, see [Tagging
4301
4357
  # resources][1] in the Amazon Bedrock User Guide.
4302
4358
  #
@@ -5675,7 +5731,7 @@ module Aws::BedrockAgent
5675
5731
  tracer: tracer
5676
5732
  )
5677
5733
  context[:gem_name] = 'aws-sdk-bedrockagent'
5678
- context[:gem_version] = '1.26.0'
5734
+ context[:gem_version] = '1.28.0'
5679
5735
  Seahorse::Client::Request.new(handlers, context)
5680
5736
  end
5681
5737
 
@@ -407,6 +407,8 @@ module Aws::BedrockAgent
407
407
  StartIngestionJobRequest = Shapes::StructureShape.new(name: 'StartIngestionJobRequest')
408
408
  StartIngestionJobResponse = Shapes::StructureShape.new(name: 'StartIngestionJobResponse')
409
409
  StepType = Shapes::StringShape.new(name: 'StepType')
410
+ StopIngestionJobRequest = Shapes::StructureShape.new(name: 'StopIngestionJobRequest')
411
+ StopIngestionJobResponse = Shapes::StructureShape.new(name: 'StopIngestionJobResponse')
410
412
  StopSequences = Shapes::ListShape.new(name: 'StopSequences')
411
413
  StorageConfiguration = Shapes::StructureShape.new(name: 'StorageConfiguration')
412
414
  StorageDays = Shapes::IntegerShape.new(name: 'StorageDays')
@@ -1748,6 +1750,14 @@ module Aws::BedrockAgent
1748
1750
  StartIngestionJobResponse.add_member(:ingestion_job, Shapes::ShapeRef.new(shape: IngestionJob, required: true, location_name: "ingestionJob"))
1749
1751
  StartIngestionJobResponse.struct_class = Types::StartIngestionJobResponse
1750
1752
 
1753
+ StopIngestionJobRequest.add_member(:data_source_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "dataSourceId"))
1754
+ StopIngestionJobRequest.add_member(:ingestion_job_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "ingestionJobId"))
1755
+ StopIngestionJobRequest.add_member(:knowledge_base_id, Shapes::ShapeRef.new(shape: Id, required: true, location: "uri", location_name: "knowledgeBaseId"))
1756
+ StopIngestionJobRequest.struct_class = Types::StopIngestionJobRequest
1757
+
1758
+ StopIngestionJobResponse.add_member(:ingestion_job, Shapes::ShapeRef.new(shape: IngestionJob, required: true, location_name: "ingestionJob"))
1759
+ StopIngestionJobResponse.struct_class = Types::StopIngestionJobResponse
1760
+
1751
1761
  StopSequences.member = Shapes::ShapeRef.new(shape: String)
1752
1762
 
1753
1763
  StorageConfiguration.add_member(:mongo_db_atlas_configuration, Shapes::ShapeRef.new(shape: MongoDbAtlasConfiguration, location_name: "mongoDbAtlasConfiguration"))
@@ -2748,6 +2758,20 @@ module Aws::BedrockAgent
2748
2758
  o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
2749
2759
  end)
2750
2760
 
2761
+ api.add_operation(:stop_ingestion_job, Seahorse::Model::Operation.new.tap do |o|
2762
+ o.name = "StopIngestionJob"
2763
+ o.http_method = "POST"
2764
+ o.http_request_uri = "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/{ingestionJobId}/stop"
2765
+ o.input = Shapes::ShapeRef.new(shape: StopIngestionJobRequest)
2766
+ o.output = Shapes::ShapeRef.new(shape: StopIngestionJobResponse)
2767
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
2768
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
2769
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
2770
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
2771
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
2772
+ o.errors << Shapes::ShapeRef.new(shape: ConflictException)
2773
+ end)
2774
+
2751
2775
  api.add_operation(:tag_resource, Seahorse::Model::Operation.new.tap do |o|
2752
2776
  o.name = "TagResource"
2753
2777
  o.http_method = "POST"
@@ -562,6 +562,17 @@ module Aws::BedrockAgent
562
562
  end
563
563
  end
564
564
 
565
+ class StopIngestionJob
566
+ def self.build(context)
567
+ Aws::BedrockAgent::EndpointParameters.new(
568
+ region: context.config.region,
569
+ use_dual_stack: context.config.use_dualstack_endpoint,
570
+ use_fips: context.config.use_fips_endpoint,
571
+ endpoint: context.config.regional_endpoint ? nil : context.config.endpoint.to_s,
572
+ )
573
+ end
574
+ end
575
+
565
576
  class TagResource
566
577
  def self.build(context)
567
578
  Aws::BedrockAgent::EndpointParameters.new(
@@ -170,6 +170,8 @@ The endpoint provider used to resolve endpoints. Any object that responds to
170
170
  Aws::BedrockAgent::Endpoints::PrepareFlow.build(context)
171
171
  when :start_ingestion_job
172
172
  Aws::BedrockAgent::Endpoints::StartIngestionJob.build(context)
173
+ when :stop_ingestion_job
174
+ Aws::BedrockAgent::Endpoints::StopIngestionJob.build(context)
173
175
  when :tag_resource
174
176
  Aws::BedrockAgent::Endpoints::TagResource.build(context)
175
177
  when :untag_resource
@@ -3671,8 +3671,7 @@ module Aws::BedrockAgent
3671
3671
  # @return [String]
3672
3672
  #
3673
3673
  # @!attribute [rw] knowledge_base_id
3674
- # The unique identifier of the knowledge base that the data source was
3675
- # added to.
3674
+ # The unique identifier of the knowledge base for the data source.
3676
3675
  # @return [String]
3677
3676
  #
3678
3677
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetDataSourceRequest AWS API Documentation
@@ -3953,16 +3952,18 @@ module Aws::BedrockAgent
3953
3952
  end
3954
3953
 
3955
3954
  # @!attribute [rw] data_source_id
3956
- # The unique identifier of the data source in the ingestion job.
3955
+ # The unique identifier of the data source for the data ingestion job
3956
+ # you want to get information on.
3957
3957
  # @return [String]
3958
3958
  #
3959
3959
  # @!attribute [rw] ingestion_job_id
3960
- # The unique identifier of the ingestion job.
3960
+ # The unique identifier of the data ingestion job you want to get
3961
+ # information on.
3961
3962
  # @return [String]
3962
3963
  #
3963
3964
  # @!attribute [rw] knowledge_base_id
3964
- # The unique identifier of the knowledge base for which the ingestion
3965
- # job applies.
3965
+ # The unique identifier of the knowledge base for the data ingestion
3966
+ # job you want to get information on.
3966
3967
  # @return [String]
3967
3968
  #
3968
3969
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetIngestionJobRequest AWS API Documentation
@@ -3976,7 +3977,7 @@ module Aws::BedrockAgent
3976
3977
  end
3977
3978
 
3978
3979
  # @!attribute [rw] ingestion_job
3979
- # Contains details about the ingestion job.
3980
+ # Contains details about the data ingestion job.
3980
3981
  # @return [Types::IngestionJob]
3981
3982
  #
3982
3983
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetIngestionJobResponse AWS API Documentation
@@ -3988,8 +3989,8 @@ module Aws::BedrockAgent
3988
3989
  end
3989
3990
 
3990
3991
  # @!attribute [rw] knowledge_base_id
3991
- # The unique identifier of the knowledge base for which to get
3992
- # information.
3992
+ # The unique identifier of the knowledge base you want to get
3993
+ # information on.
3993
3994
  # @return [String]
3994
3995
  #
3995
3996
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetKnowledgeBaseRequest AWS API Documentation
@@ -4212,8 +4213,9 @@ module Aws::BedrockAgent
4212
4213
  include Aws::Structure
4213
4214
  end
4214
4215
 
4215
- # Contains details about an ingestion job, which converts a data source
4216
- # to embeddings for a vector store in knowledge base.
4216
+ # Contains details about a data ingestion job. Data sources are ingested
4217
+ # into a knowledge base so that Large Language Models (LLMs) can use
4218
+ # your data.
4217
4219
  #
4218
4220
  # This data type is used in the following API operations:
4219
4221
  #
@@ -4230,40 +4232,45 @@ module Aws::BedrockAgent
4230
4232
  # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListIngestionJobs.html#API_agent_ListIngestionJobs_ResponseSyntax
4231
4233
  #
4232
4234
  # @!attribute [rw] data_source_id
4233
- # The unique identifier of the ingested data source.
4235
+ # The unique identifier of the data source for the data ingestion job.
4234
4236
  # @return [String]
4235
4237
  #
4236
4238
  # @!attribute [rw] description
4237
- # The description of the ingestion job.
4239
+ # The description of the data ingestion job.
4238
4240
  # @return [String]
4239
4241
  #
4240
4242
  # @!attribute [rw] failure_reasons
4241
- # A list of reasons that the ingestion job failed.
4243
+ # A list of reasons that the data ingestion job failed.
4242
4244
  # @return [Array<String>]
4243
4245
  #
4244
4246
  # @!attribute [rw] ingestion_job_id
4245
- # The unique identifier of the ingestion job.
4247
+ # The unique identifier of the data ingestion job.
4246
4248
  # @return [String]
4247
4249
  #
4248
4250
  # @!attribute [rw] knowledge_base_id
4249
- # The unique identifier of the knowledge base to which the data source
4250
- # is being added.
4251
+ # The unique identifier of the knowledge for the data ingestion job.
4251
4252
  # @return [String]
4252
4253
  #
4253
4254
  # @!attribute [rw] started_at
4254
- # The time at which the ingestion job started.
4255
+ # The time the data ingestion job started.
4256
+ #
4257
+ # If you stop a data ingestion job, the `startedAt` time is the time
4258
+ # the job was started before the job was stopped.
4255
4259
  # @return [Time]
4256
4260
  #
4257
4261
  # @!attribute [rw] statistics
4258
- # Contains statistics about the ingestion job.
4262
+ # Contains statistics about the data ingestion job.
4259
4263
  # @return [Types::IngestionJobStatistics]
4260
4264
  #
4261
4265
  # @!attribute [rw] status
4262
- # The status of the ingestion job.
4266
+ # The status of the data ingestion job.
4263
4267
  # @return [String]
4264
4268
  #
4265
4269
  # @!attribute [rw] updated_at
4266
- # The time at which the ingestion job was last updated.
4270
+ # The time the data ingestion job was last updated.
4271
+ #
4272
+ # If you stop a data ingestion job, the `updatedAt` time is the time
4273
+ # the job was stopped.
4267
4274
  # @return [Time]
4268
4275
  #
4269
4276
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IngestionJob AWS API Documentation
@@ -4282,18 +4289,18 @@ module Aws::BedrockAgent
4282
4289
  include Aws::Structure
4283
4290
  end
4284
4291
 
4285
- # Defines a filter by which to filter the results.
4292
+ # The definition of a filter to filter the data.
4286
4293
  #
4287
4294
  # @!attribute [rw] attribute
4288
- # The attribute by which to filter the results.
4295
+ # The name of field or attribute to apply the filter.
4289
4296
  # @return [String]
4290
4297
  #
4291
4298
  # @!attribute [rw] operator
4292
- # The operation to carry out between the attribute and the values.
4299
+ # The operation to apply to the field or attribute.
4293
4300
  # @return [String]
4294
4301
  #
4295
4302
  # @!attribute [rw] values
4296
- # A list of values for the attribute.
4303
+ # A list of values that belong to the field or attribute.
4297
4304
  # @return [Array<String>]
4298
4305
  #
4299
4306
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IngestionJobFilter AWS API Documentation
@@ -4306,14 +4313,14 @@ module Aws::BedrockAgent
4306
4313
  include Aws::Structure
4307
4314
  end
4308
4315
 
4309
- # Parameters by which to sort the results.
4316
+ # The parameters of sorting the data.
4310
4317
  #
4311
4318
  # @!attribute [rw] attribute
4312
- # The attribute by which to sort the results.
4319
+ # The name of field or attribute to apply sorting of data.
4313
4320
  # @return [String]
4314
4321
  #
4315
4322
  # @!attribute [rw] order
4316
- # The order by which to sort the results.
4323
+ # The order for sorting the data.
4317
4324
  # @return [String]
4318
4325
  #
4319
4326
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IngestionJobSortBy AWS API Documentation
@@ -4325,10 +4332,10 @@ module Aws::BedrockAgent
4325
4332
  include Aws::Structure
4326
4333
  end
4327
4334
 
4328
- # Contains the statistics for the ingestion job.
4335
+ # Contains the statistics for the data ingestion job.
4329
4336
  #
4330
4337
  # @!attribute [rw] number_of_documents_deleted
4331
- # The number of source documents that was deleted.
4338
+ # The number of source documents that were deleted.
4332
4339
  # @return [Integer]
4333
4340
  #
4334
4341
  # @!attribute [rw] number_of_documents_failed
@@ -4373,39 +4380,39 @@ module Aws::BedrockAgent
4373
4380
  include Aws::Structure
4374
4381
  end
4375
4382
 
4376
- # Contains details about an ingestion job.
4383
+ # Contains details about a data ingestion job.
4377
4384
  #
4378
4385
  # @!attribute [rw] data_source_id
4379
- # The unique identifier of the data source in the ingestion job.
4386
+ # The unique identifier of the data source for the data ingestion job.
4380
4387
  # @return [String]
4381
4388
  #
4382
4389
  # @!attribute [rw] description
4383
- # The description of the ingestion job.
4390
+ # The description of the data ingestion job.
4384
4391
  # @return [String]
4385
4392
  #
4386
4393
  # @!attribute [rw] ingestion_job_id
4387
- # The unique identifier of the ingestion job.
4394
+ # The unique identifier of the data ingestion job.
4388
4395
  # @return [String]
4389
4396
  #
4390
4397
  # @!attribute [rw] knowledge_base_id
4391
- # The unique identifier of the knowledge base to which the data source
4392
- # is added.
4398
+ # The unique identifier of the knowledge base for the data ingestion
4399
+ # job.
4393
4400
  # @return [String]
4394
4401
  #
4395
4402
  # @!attribute [rw] started_at
4396
- # The time at which the ingestion job was started.
4403
+ # The time the data ingestion job started.
4397
4404
  # @return [Time]
4398
4405
  #
4399
4406
  # @!attribute [rw] statistics
4400
- # Contains statistics for the ingestion job.
4407
+ # Contains statistics for the data ingestion job.
4401
4408
  # @return [Types::IngestionJobStatistics]
4402
4409
  #
4403
4410
  # @!attribute [rw] status
4404
- # The status of the ingestion job.
4411
+ # The status of the data ingestion job.
4405
4412
  # @return [String]
4406
4413
  #
4407
4414
  # @!attribute [rw] updated_at
4408
- # The time at which the ingestion job was last updated.
4415
+ # The time the data ingestion job was last updated.
4409
4416
  # @return [Time]
4410
4417
  #
4411
4418
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IngestionJobSummary AWS API Documentation
@@ -4479,7 +4486,7 @@ module Aws::BedrockAgent
4479
4486
  # Contains information about a knowledge base.
4480
4487
  #
4481
4488
  # @!attribute [rw] created_at
4482
- # The time at which the knowledge base was created.
4489
+ # The time the knowledge base was created.
4483
4490
  # @return [Time]
4484
4491
  #
4485
4492
  # @!attribute [rw] description
@@ -4534,7 +4541,7 @@ module Aws::BedrockAgent
4534
4541
  # @return [Types::StorageConfiguration]
4535
4542
  #
4536
4543
  # @!attribute [rw] updated_at
4537
- # The time at which the knowledge base was last updated.
4544
+ # The time the knowledge base was last updated.
4538
4545
  # @return [Time]
4539
4546
  #
4540
4547
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBase AWS API Documentation
@@ -4555,8 +4562,8 @@ module Aws::BedrockAgent
4555
4562
  include Aws::Structure
4556
4563
  end
4557
4564
 
4558
- # Contains details about the embeddings configuration of the knowledge
4559
- # base.
4565
+ # Contains details about the vector embeddings configuration of the
4566
+ # knowledge base.
4560
4567
  #
4561
4568
  # @!attribute [rw] type
4562
4569
  # The type of data that the data source is converted into for the
@@ -4564,8 +4571,8 @@ module Aws::BedrockAgent
4564
4571
  # @return [String]
4565
4572
  #
4566
4573
  # @!attribute [rw] vector_knowledge_base_configuration
4567
- # Contains details about the embeddings model that'sused to convert
4568
- # the data source.
4574
+ # Contains details about the model that's used to convert the data
4575
+ # source into vector embeddings.
4569
4576
  # @return [Types::VectorKnowledgeBaseConfiguration]
4570
4577
  #
4571
4578
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBaseConfiguration AWS API Documentation
@@ -4629,7 +4636,7 @@ module Aws::BedrockAgent
4629
4636
  # @return [String]
4630
4637
  #
4631
4638
  # @!attribute [rw] updated_at
4632
- # The time at which the knowledge base was last updated.
4639
+ # The time the knowledge base was last updated.
4633
4640
  # @return [Time]
4634
4641
  #
4635
4642
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBaseSummary AWS API Documentation
@@ -5137,16 +5144,16 @@ module Aws::BedrockAgent
5137
5144
  end
5138
5145
 
5139
5146
  # @!attribute [rw] data_source_id
5140
- # The unique identifier of the data source for which to return
5147
+ # The unique identifier of the data source for the list of data
5141
5148
  # ingestion jobs.
5142
5149
  # @return [String]
5143
5150
  #
5144
5151
  # @!attribute [rw] filters
5145
- # Contains a definition of a filter for which to filter the results.
5152
+ # Contains information about the filters for filtering the data.
5146
5153
  # @return [Array<Types::IngestionJobFilter>]
5147
5154
  #
5148
5155
  # @!attribute [rw] knowledge_base_id
5149
- # The unique identifier of the knowledge base for which to return
5156
+ # The unique identifier of the knowledge base for the list of data
5150
5157
  # ingestion jobs.
5151
5158
  # @return [String]
5152
5159
  #
@@ -5165,7 +5172,7 @@ module Aws::BedrockAgent
5165
5172
  # @return [String]
5166
5173
  #
5167
5174
  # @!attribute [rw] sort_by
5168
- # Contains details about how to sort the results.
5175
+ # Contains details about how to sort the data.
5169
5176
  # @return [Types::IngestionJobSortBy]
5170
5177
  #
5171
5178
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListIngestionJobsRequest AWS API Documentation
@@ -5182,8 +5189,7 @@ module Aws::BedrockAgent
5182
5189
  end
5183
5190
 
5184
5191
  # @!attribute [rw] ingestion_job_summaries
5185
- # A list of objects, each of which contains information about an
5186
- # ingestion job.
5192
+ # A list of data ingestion jobs with information about each job.
5187
5193
  # @return [Array<Types::IngestionJobSummary>]
5188
5194
  #
5189
5195
  # @!attribute [rw] next_token
@@ -5226,8 +5232,8 @@ module Aws::BedrockAgent
5226
5232
  end
5227
5233
 
5228
5234
  # @!attribute [rw] knowledge_base_summaries
5229
- # A list of objects, each of which contains information about a
5230
- # knowledge base.
5235
+ # A list of knowledge bases with information about each knowledge
5236
+ # base.
5231
5237
  # @return [Array<Types::KnowledgeBaseSummary>]
5232
5238
  #
5233
5239
  # @!attribute [rw] next_token
@@ -6783,16 +6789,17 @@ module Aws::BedrockAgent
6783
6789
  # @return [String]
6784
6790
  #
6785
6791
  # @!attribute [rw] data_source_id
6786
- # The unique identifier of the data source to ingest.
6792
+ # The unique identifier of the data source you want to ingest into
6793
+ # your knowledge base.
6787
6794
  # @return [String]
6788
6795
  #
6789
6796
  # @!attribute [rw] description
6790
- # A description of the ingestion job.
6797
+ # A description of the data ingestion job.
6791
6798
  # @return [String]
6792
6799
  #
6793
6800
  # @!attribute [rw] knowledge_base_id
6794
- # The unique identifier of the knowledge base to which to add the data
6795
- # source.
6801
+ # The unique identifier of the knowledge base for the data ingestion
6802
+ # job.
6796
6803
  # @return [String]
6797
6804
  #
6798
6805
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StartIngestionJobRequest AWS API Documentation
@@ -6807,7 +6814,7 @@ module Aws::BedrockAgent
6807
6814
  end
6808
6815
 
6809
6816
  # @!attribute [rw] ingestion_job
6810
- # An object containing information about the ingestion job.
6817
+ # Contains information about the data ingestion job.
6811
6818
  # @return [Types::IngestionJob]
6812
6819
  #
6813
6820
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StartIngestionJobResponse AWS API Documentation
@@ -6818,6 +6825,42 @@ module Aws::BedrockAgent
6818
6825
  include Aws::Structure
6819
6826
  end
6820
6827
 
6828
+ # @!attribute [rw] data_source_id
6829
+ # The unique identifier of the data source for the data ingestion job
6830
+ # you want to stop.
6831
+ # @return [String]
6832
+ #
6833
+ # @!attribute [rw] ingestion_job_id
6834
+ # The unique identifier of the data ingestion job you want to stop.
6835
+ # @return [String]
6836
+ #
6837
+ # @!attribute [rw] knowledge_base_id
6838
+ # The unique identifier of the knowledge base for the data ingestion
6839
+ # job you want to stop.
6840
+ # @return [String]
6841
+ #
6842
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StopIngestionJobRequest AWS API Documentation
6843
+ #
6844
+ class StopIngestionJobRequest < Struct.new(
6845
+ :data_source_id,
6846
+ :ingestion_job_id,
6847
+ :knowledge_base_id)
6848
+ SENSITIVE = []
6849
+ include Aws::Structure
6850
+ end
6851
+
6852
+ # @!attribute [rw] ingestion_job
6853
+ # Contains information about the stopped data ingestion job.
6854
+ # @return [Types::IngestionJob]
6855
+ #
6856
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StopIngestionJobResponse AWS API Documentation
6857
+ #
6858
+ class StopIngestionJobResponse < Struct.new(
6859
+ :ingestion_job)
6860
+ SENSITIVE = []
6861
+ include Aws::Structure
6862
+ end
6863
+
6821
6864
  # Contains the storage configuration of the knowledge base.
6822
6865
  #
6823
6866
  # @!attribute [rw] mongo_db_atlas_configuration
@@ -11,6 +11,8 @@
11
11
  require 'aws-sdk-core'
12
12
  require 'aws-sigv4'
13
13
 
14
+ Aws::Plugins::GlobalConfiguration.add_identifier(:bedrockagent)
15
+
14
16
  # This module provides support for Agents for Amazon Bedrock. This module is available in the
15
17
  # `aws-sdk-bedrockagent` gem.
16
18
  #
@@ -52,7 +54,7 @@ module Aws::BedrockAgent
52
54
  autoload :EndpointProvider, 'aws-sdk-bedrockagent/endpoint_provider'
53
55
  autoload :Endpoints, 'aws-sdk-bedrockagent/endpoints'
54
56
 
55
- GEM_VERSION = '1.26.0'
57
+ GEM_VERSION = '1.28.0'
56
58
 
57
59
  end
58
60
 
data/sig/client.rbs CHANGED
@@ -1215,6 +1215,18 @@ module Aws
1215
1215
  ) -> _StartIngestionJobResponseSuccess
1216
1216
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartIngestionJobResponseSuccess
1217
1217
 
1218
+ interface _StopIngestionJobResponseSuccess
1219
+ include ::Seahorse::Client::_ResponseSuccess[Types::StopIngestionJobResponse]
1220
+ def ingestion_job: () -> Types::IngestionJob
1221
+ end
1222
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#stop_ingestion_job-instance_method
1223
+ def stop_ingestion_job: (
1224
+ data_source_id: ::String,
1225
+ ingestion_job_id: ::String,
1226
+ knowledge_base_id: ::String
1227
+ ) -> _StopIngestionJobResponseSuccess
1228
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StopIngestionJobResponseSuccess
1229
+
1218
1230
  interface _TagResourceResponseSuccess
1219
1231
  include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceResponse]
1220
1232
  end
data/sig/types.rbs CHANGED
@@ -1036,7 +1036,7 @@ module Aws::BedrockAgent
1036
1036
  attr_accessor knowledge_base_id: ::String
1037
1037
  attr_accessor started_at: ::Time
1038
1038
  attr_accessor statistics: Types::IngestionJobStatistics
1039
- attr_accessor status: ("STARTING" | "IN_PROGRESS" | "COMPLETE" | "FAILED")
1039
+ attr_accessor status: ("STARTING" | "IN_PROGRESS" | "COMPLETE" | "FAILED" | "STOPPING" | "STOPPED")
1040
1040
  attr_accessor updated_at: ::Time
1041
1041
  SENSITIVE: []
1042
1042
  end
@@ -1072,7 +1072,7 @@ module Aws::BedrockAgent
1072
1072
  attr_accessor knowledge_base_id: ::String
1073
1073
  attr_accessor started_at: ::Time
1074
1074
  attr_accessor statistics: Types::IngestionJobStatistics
1075
- attr_accessor status: ("STARTING" | "IN_PROGRESS" | "COMPLETE" | "FAILED")
1075
+ attr_accessor status: ("STARTING" | "IN_PROGRESS" | "COMPLETE" | "FAILED" | "STOPPING" | "STOPPED")
1076
1076
  attr_accessor updated_at: ::Time
1077
1077
  SENSITIVE: []
1078
1078
  end
@@ -1678,6 +1678,18 @@ module Aws::BedrockAgent
1678
1678
  SENSITIVE: []
1679
1679
  end
1680
1680
 
1681
+ class StopIngestionJobRequest
1682
+ attr_accessor data_source_id: ::String
1683
+ attr_accessor ingestion_job_id: ::String
1684
+ attr_accessor knowledge_base_id: ::String
1685
+ SENSITIVE: []
1686
+ end
1687
+
1688
+ class StopIngestionJobResponse
1689
+ attr_accessor ingestion_job: Types::IngestionJob
1690
+ SENSITIVE: []
1691
+ end
1692
+
1681
1693
  class StorageConfiguration
1682
1694
  attr_accessor mongo_db_atlas_configuration: Types::MongoDbAtlasConfiguration
1683
1695
  attr_accessor opensearch_serverless_configuration: Types::OpenSearchServerlessConfiguration
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-bedrockagent
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.26.0
4
+ version: 1.28.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-09-23 00:00:00.000000000 Z
11
+ date: 2024-10-01 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core