aws-sdk-bedrockagentcorecontrol 1.47.0 → 1.48.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-bedrockagentcorecontrol/client.rb +754 -8
- data/lib/aws-sdk-bedrockagentcorecontrol/client_api.rb +405 -0
- data/lib/aws-sdk-bedrockagentcorecontrol/types.rb +873 -5
- data/lib/aws-sdk-bedrockagentcorecontrol.rb +2 -2
- data/sig/client.rbs +183 -0
- data/sig/params.rbs +12 -0
- data/sig/types.rbs +225 -0
- metadata +3 -3
|
@@ -199,7 +199,7 @@ module Aws::BedrockAgentCoreControl
|
|
|
199
199
|
# the required types.
|
|
200
200
|
#
|
|
201
201
|
# @option options [Boolean] :correct_clock_skew (true)
|
|
202
|
-
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
|
202
|
+
# Used only in `standard` and `adaptive` retry modes. Specifies whether to apply
|
|
203
203
|
# a clock skew correction and retry requests with skewed client clocks.
|
|
204
204
|
#
|
|
205
205
|
# @option options [String] :defaults_mode ("legacy")
|
|
@@ -323,17 +323,15 @@ module Aws::BedrockAgentCoreControl
|
|
|
323
323
|
# @option options [String] :retry_mode ("legacy")
|
|
324
324
|
# Specifies which retry algorithm to use. Values are:
|
|
325
325
|
#
|
|
326
|
-
# * `legacy` - The pre-existing retry behavior.
|
|
327
|
-
# no retry mode is provided.
|
|
326
|
+
# * `legacy` - The pre-existing retry behavior. This is the default
|
|
327
|
+
# value if no retry mode is provided.
|
|
328
328
|
#
|
|
329
329
|
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
|
330
330
|
# This includes support for retry quotas, which limit the number of
|
|
331
331
|
# unsuccessful retries a client can make.
|
|
332
332
|
#
|
|
333
|
-
# * `adaptive` -
|
|
334
|
-
#
|
|
335
|
-
# throttling. This is a provisional mode that may change behavior
|
|
336
|
-
# in the future.
|
|
333
|
+
# * `adaptive` - A retry mode that includes all the functionality of
|
|
334
|
+
# `standard` mode along with automatic client side throttling.
|
|
337
335
|
#
|
|
338
336
|
# @option options [String] :sdk_ua_app_id
|
|
339
337
|
# A unique and opaque application ID that is appended to the
|
|
@@ -476,6 +474,89 @@ module Aws::BedrockAgentCoreControl
|
|
|
476
474
|
|
|
477
475
|
# @!group API Operations
|
|
478
476
|
|
|
477
|
+
# Adds examples to the dataset's DRAFT.
|
|
478
|
+
#
|
|
479
|
+
# **Validation:** All examples are validated against the dataset's
|
|
480
|
+
# schemaType before any writes occur. If any example fails validation,
|
|
481
|
+
# the entire batch is rejected with ValidationException — no examples
|
|
482
|
+
# are written (all-or-nothing semantics).
|
|
483
|
+
#
|
|
484
|
+
# **Asynchronous:** Operates in-place on DRAFT. No version bump occurs.
|
|
485
|
+
# Use CreateDatasetVersion to publish DRAFT as a new numbered version.
|
|
486
|
+
#
|
|
487
|
+
# **State guard:** Returns ConflictException (DATASET\_NOT\_READY) if
|
|
488
|
+
# the dataset status is not in \{DRAFT, ACTIVE}.
|
|
489
|
+
#
|
|
490
|
+
# **Request size limit:** Max 5 MB total request body. Max 1000 examples
|
|
491
|
+
# per call.
|
|
492
|
+
#
|
|
493
|
+
# @option params [required, String] :dataset_id
|
|
494
|
+
# The unique identifier of the dataset to add examples to.
|
|
495
|
+
#
|
|
496
|
+
# @option params [String] :client_token
|
|
497
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
|
498
|
+
# completes no more than one time. If you don't specify this field, a
|
|
499
|
+
# value is randomly generated for you. If this token matches a previous
|
|
500
|
+
# request, the service ignores the request, but doesn't return an
|
|
501
|
+
# error. For more information, see [Ensuring idempotency][1].
|
|
502
|
+
#
|
|
503
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
504
|
+
# not need to pass this option.**
|
|
505
|
+
#
|
|
506
|
+
#
|
|
507
|
+
#
|
|
508
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
|
509
|
+
#
|
|
510
|
+
# @option params [required, Types::DataSourceType] :source
|
|
511
|
+
# Source of examples to add. Provide either inline examples or an S3 URI
|
|
512
|
+
# pointing to a JSONL file.
|
|
513
|
+
#
|
|
514
|
+
# @return [Types::AddDatasetExamplesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
515
|
+
#
|
|
516
|
+
# * {Types::AddDatasetExamplesResponse#dataset_arn #dataset_arn} => String
|
|
517
|
+
# * {Types::AddDatasetExamplesResponse#dataset_id #dataset_id} => String
|
|
518
|
+
# * {Types::AddDatasetExamplesResponse#status #status} => String
|
|
519
|
+
# * {Types::AddDatasetExamplesResponse#added_count #added_count} => Integer
|
|
520
|
+
# * {Types::AddDatasetExamplesResponse#updated_at #updated_at} => Time
|
|
521
|
+
# * {Types::AddDatasetExamplesResponse#example_ids #example_ids} => Array<String>
|
|
522
|
+
#
|
|
523
|
+
# @example Request syntax with placeholder values
|
|
524
|
+
#
|
|
525
|
+
# resp = client.add_dataset_examples({
|
|
526
|
+
# dataset_id: "DatasetId", # required
|
|
527
|
+
# client_token: "ClientToken",
|
|
528
|
+
# source: { # required
|
|
529
|
+
# inline_examples: {
|
|
530
|
+
# examples: [ # required
|
|
531
|
+
# {
|
|
532
|
+
# },
|
|
533
|
+
# ],
|
|
534
|
+
# },
|
|
535
|
+
# s3_source: {
|
|
536
|
+
# s3_uri: "S3Uri", # required
|
|
537
|
+
# },
|
|
538
|
+
# },
|
|
539
|
+
# })
|
|
540
|
+
#
|
|
541
|
+
# @example Response structure
|
|
542
|
+
#
|
|
543
|
+
# resp.dataset_arn #=> String
|
|
544
|
+
# resp.dataset_id #=> String
|
|
545
|
+
# resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
|
|
546
|
+
# resp.added_count #=> Integer
|
|
547
|
+
# resp.updated_at #=> Time
|
|
548
|
+
# resp.example_ids #=> Array
|
|
549
|
+
# resp.example_ids[0] #=> String
|
|
550
|
+
#
|
|
551
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/AddDatasetExamples AWS API Documentation
|
|
552
|
+
#
|
|
553
|
+
# @overload add_dataset_examples(params = {})
|
|
554
|
+
# @param [Hash] params ({})
|
|
555
|
+
def add_dataset_examples(params = {}, options = {})
|
|
556
|
+
req = build_request(:add_dataset_examples, params)
|
|
557
|
+
req.send_request(options)
|
|
558
|
+
end
|
|
559
|
+
|
|
479
560
|
# Creates an Amazon Bedrock AgentCore Runtime.
|
|
480
561
|
#
|
|
481
562
|
# @option params [required, String] :agent_runtime_name
|
|
@@ -1149,6 +1230,149 @@ module Aws::BedrockAgentCoreControl
|
|
|
1149
1230
|
req.send_request(options)
|
|
1150
1231
|
end
|
|
1151
1232
|
|
|
1233
|
+
# Creates a new Dataset resource asynchronously.
|
|
1234
|
+
#
|
|
1235
|
+
# Returns immediately with status CREATING. Poll GetDataset until status
|
|
1236
|
+
# transitions to ACTIVE or CREATE\_FAILED (with failureReason).
|
|
1237
|
+
#
|
|
1238
|
+
# @option params [String] :client_token
|
|
1239
|
+
# Optional idempotency token.
|
|
1240
|
+
#
|
|
1241
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
1242
|
+
# not need to pass this option.**
|
|
1243
|
+
#
|
|
1244
|
+
# @option params [required, String] :dataset_name
|
|
1245
|
+
# Human-readable name for the dataset. Unique within the account
|
|
1246
|
+
# (case-insensitive). Immutable after creation.
|
|
1247
|
+
#
|
|
1248
|
+
# @option params [String] :description
|
|
1249
|
+
# A description of the dataset.
|
|
1250
|
+
#
|
|
1251
|
+
# @option params [required, Types::DataSourceType] :source
|
|
1252
|
+
# Source of initial examples. Provide either inline examples or an S3
|
|
1253
|
+
# URI pointing to a JSONL file.
|
|
1254
|
+
#
|
|
1255
|
+
# @option params [required, String] :schema_type
|
|
1256
|
+
# Versioned schema type governing the structure of examples. Immutable
|
|
1257
|
+
# after creation.
|
|
1258
|
+
#
|
|
1259
|
+
# @option params [String] :kms_key_arn
|
|
1260
|
+
# Optional AWS KMS key ARN for SSE-KMS on service S3 writes.
|
|
1261
|
+
#
|
|
1262
|
+
# @option params [Hash<String,String>] :tags
|
|
1263
|
+
# A map of tag keys and values to assign to the dataset.
|
|
1264
|
+
#
|
|
1265
|
+
# @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1266
|
+
#
|
|
1267
|
+
# * {Types::CreateDatasetResponse#dataset_arn #dataset_arn} => String
|
|
1268
|
+
# * {Types::CreateDatasetResponse#dataset_id #dataset_id} => String
|
|
1269
|
+
# * {Types::CreateDatasetResponse#status #status} => String
|
|
1270
|
+
# * {Types::CreateDatasetResponse#created_at #created_at} => Time
|
|
1271
|
+
#
|
|
1272
|
+
# @example Request syntax with placeholder values
|
|
1273
|
+
#
|
|
1274
|
+
# resp = client.create_dataset({
|
|
1275
|
+
# client_token: "ClientToken",
|
|
1276
|
+
# dataset_name: "DatasetName", # required
|
|
1277
|
+
# description: "CreateDatasetRequestDescriptionString",
|
|
1278
|
+
# source: { # required
|
|
1279
|
+
# inline_examples: {
|
|
1280
|
+
# examples: [ # required
|
|
1281
|
+
# {
|
|
1282
|
+
# },
|
|
1283
|
+
# ],
|
|
1284
|
+
# },
|
|
1285
|
+
# s3_source: {
|
|
1286
|
+
# s3_uri: "S3Uri", # required
|
|
1287
|
+
# },
|
|
1288
|
+
# },
|
|
1289
|
+
# schema_type: "AGENTCORE_EVALUATION_PREDEFINED_V1", # required, accepts AGENTCORE_EVALUATION_PREDEFINED_V1, AGENTCORE_EVALUATION_SIMULATED_V1
|
|
1290
|
+
# kms_key_arn: "KmsKeyArn",
|
|
1291
|
+
# tags: {
|
|
1292
|
+
# "TagKey" => "TagValue",
|
|
1293
|
+
# },
|
|
1294
|
+
# })
|
|
1295
|
+
#
|
|
1296
|
+
# @example Response structure
|
|
1297
|
+
#
|
|
1298
|
+
# resp.dataset_arn #=> String
|
|
1299
|
+
# resp.dataset_id #=> String
|
|
1300
|
+
# resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
|
|
1301
|
+
# resp.created_at #=> Time
|
|
1302
|
+
#
|
|
1303
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/CreateDataset AWS API Documentation
|
|
1304
|
+
#
|
|
1305
|
+
# @overload create_dataset(params = {})
|
|
1306
|
+
# @param [Hash] params ({})
|
|
1307
|
+
def create_dataset(params = {}, options = {})
|
|
1308
|
+
req = build_request(:create_dataset, params)
|
|
1309
|
+
req.send_request(options)
|
|
1310
|
+
end
|
|
1311
|
+
|
|
1312
|
+
# Publishes the current DRAFT as a new numbered version.
|
|
1313
|
+
#
|
|
1314
|
+
# Snapshots the DRAFT examples as the next version (1, 2, 3, ...). The
|
|
1315
|
+
# DRAFT is preserved and remains editable after publishing. Returns
|
|
1316
|
+
# immediately with status UPDATING. Poll GetDataset until status
|
|
1317
|
+
# transitions to ACTIVE (draftStatus=UNMODIFIED) or UPDATE\_FAILED.
|
|
1318
|
+
#
|
|
1319
|
+
# **State guard:** Returns ConflictException (DATASET\_NOT\_READY) if
|
|
1320
|
+
# status is in \{CREATING, UPDATING, DELETING}, or
|
|
1321
|
+
# DATASET\_IN\_FAILED\_STATE if status is in \{CREATE\_FAILED,
|
|
1322
|
+
# DELETE\_FAILED}.
|
|
1323
|
+
#
|
|
1324
|
+
# **Quota:** MAX\_VERSIONS\_PER\_DATASET applies to published versions
|
|
1325
|
+
# only (not DRAFT).
|
|
1326
|
+
#
|
|
1327
|
+
# @option params [required, String] :dataset_id
|
|
1328
|
+
# The unique identifier of the dataset to publish a version for.
|
|
1329
|
+
#
|
|
1330
|
+
# @option params [String] :client_token
|
|
1331
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
|
1332
|
+
# completes no more than one time. If you don't specify this field, a
|
|
1333
|
+
# value is randomly generated for you. If this token matches a previous
|
|
1334
|
+
# request, the service ignores the request, but doesn't return an
|
|
1335
|
+
# error. For more information, see [Ensuring idempotency][1].
|
|
1336
|
+
#
|
|
1337
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
1338
|
+
# not need to pass this option.**
|
|
1339
|
+
#
|
|
1340
|
+
#
|
|
1341
|
+
#
|
|
1342
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
|
1343
|
+
#
|
|
1344
|
+
# @return [Types::CreateDatasetVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1345
|
+
#
|
|
1346
|
+
# * {Types::CreateDatasetVersionResponse#dataset_arn #dataset_arn} => String
|
|
1347
|
+
# * {Types::CreateDatasetVersionResponse#dataset_id #dataset_id} => String
|
|
1348
|
+
# * {Types::CreateDatasetVersionResponse#status #status} => String
|
|
1349
|
+
# * {Types::CreateDatasetVersionResponse#dataset_version #dataset_version} => String
|
|
1350
|
+
# * {Types::CreateDatasetVersionResponse#created_at #created_at} => Time
|
|
1351
|
+
#
|
|
1352
|
+
# @example Request syntax with placeholder values
|
|
1353
|
+
#
|
|
1354
|
+
# resp = client.create_dataset_version({
|
|
1355
|
+
# dataset_id: "DatasetId", # required
|
|
1356
|
+
# client_token: "ClientToken",
|
|
1357
|
+
# })
|
|
1358
|
+
#
|
|
1359
|
+
# @example Response structure
|
|
1360
|
+
#
|
|
1361
|
+
# resp.dataset_arn #=> String
|
|
1362
|
+
# resp.dataset_id #=> String
|
|
1363
|
+
# resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
|
|
1364
|
+
# resp.dataset_version #=> String
|
|
1365
|
+
# resp.created_at #=> Time
|
|
1366
|
+
#
|
|
1367
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/CreateDatasetVersion AWS API Documentation
|
|
1368
|
+
#
|
|
1369
|
+
# @overload create_dataset_version(params = {})
|
|
1370
|
+
# @param [Hash] params ({})
|
|
1371
|
+
def create_dataset_version(params = {}, options = {})
|
|
1372
|
+
req = build_request(:create_dataset_version, params)
|
|
1373
|
+
req.send_request(options)
|
|
1374
|
+
end
|
|
1375
|
+
|
|
1152
1376
|
# Creates a custom evaluator for agent quality assessment. Custom
|
|
1153
1377
|
# evaluators can use either LLM-as-a-Judge configurations with
|
|
1154
1378
|
# user-defined prompts, rating scales, and model settings, or code-based
|
|
@@ -4488,6 +4712,147 @@ module Aws::BedrockAgentCoreControl
|
|
|
4488
4712
|
req.send_request(options)
|
|
4489
4713
|
end
|
|
4490
4714
|
|
|
4715
|
+
# Deletes a dataset version or an entire dataset (all versions + name
|
|
4716
|
+
# claim). Asynchronous 202.
|
|
4717
|
+
#
|
|
4718
|
+
# **State transitions:**
|
|
4719
|
+
#
|
|
4720
|
+
# * If `datasetVersion` is absent (full delete): status transitions to
|
|
4721
|
+
# DELETING immediately.
|
|
4722
|
+
# * If `datasetVersion` is provided (version-specific delete): status
|
|
4723
|
+
# transitions to UPDATING.
|
|
4724
|
+
#
|
|
4725
|
+
# **State guard (full delete):** Returns ConflictException
|
|
4726
|
+
# (DATASET\_NOT\_READY) if the dataset status is in \{CREATING,
|
|
4727
|
+
# UPDATING}. Deletion is allowed from ACTIVE, CREATE\_FAILED,
|
|
4728
|
+
# UPDATE\_FAILED, and DELETE\_FAILED states.
|
|
4729
|
+
#
|
|
4730
|
+
# **State guard (version-specific delete):** Returns ConflictException
|
|
4731
|
+
# (DATASET\_NOT\_READY) if the dataset status is not in \{ACTIVE,
|
|
4732
|
+
# CREATE\_FAILED, UPDATE\_FAILED}.
|
|
4733
|
+
#
|
|
4734
|
+
# Fails with ConflictException (REFERENCED\_BY\_EVAL\_JOB) if referenced
|
|
4735
|
+
# by an active evaluation job (full delete only).
|
|
4736
|
+
#
|
|
4737
|
+
# If the delete workflow fails after retries, status is set to
|
|
4738
|
+
# DELETE\_FAILED (full delete) or UPDATE\_FAILED (version-specific
|
|
4739
|
+
# delete). Calling DeleteDataset on a DELETE\_FAILED dataset re-triggers
|
|
4740
|
+
# the delete workflow (idempotent retry path).
|
|
4741
|
+
#
|
|
4742
|
+
# **Version parameter:**
|
|
4743
|
+
#
|
|
4744
|
+
# * If `datasetVersion` is absent: deletes ALL versions and the Dataset
|
|
4745
|
+
# record itself.
|
|
4746
|
+
# * If `datasetVersion` is provided: deletes only that specific
|
|
4747
|
+
# DatasetVersion. Returns ResourceNotFoundException if the specified
|
|
4748
|
+
# version does not exist.
|
|
4749
|
+
#
|
|
4750
|
+
# @option params [required, String] :dataset_id
|
|
4751
|
+
# The unique identifier of the dataset to delete.
|
|
4752
|
+
#
|
|
4753
|
+
# @option params [String] :dataset_version
|
|
4754
|
+
# Optional version to delete. Use "DRAFT" or omit to delete the draft.
|
|
4755
|
+
# Returns ResourceNotFoundException if the specified version does not
|
|
4756
|
+
# exist.
|
|
4757
|
+
#
|
|
4758
|
+
# @return [Types::DeleteDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4759
|
+
#
|
|
4760
|
+
# * {Types::DeleteDatasetResponse#dataset_arn #dataset_arn} => String
|
|
4761
|
+
# * {Types::DeleteDatasetResponse#dataset_id #dataset_id} => String
|
|
4762
|
+
# * {Types::DeleteDatasetResponse#status #status} => String
|
|
4763
|
+
# * {Types::DeleteDatasetResponse#dataset_version #dataset_version} => String
|
|
4764
|
+
# * {Types::DeleteDatasetResponse#updated_at #updated_at} => Time
|
|
4765
|
+
#
|
|
4766
|
+
# @example Request syntax with placeholder values
|
|
4767
|
+
#
|
|
4768
|
+
# resp = client.delete_dataset({
|
|
4769
|
+
# dataset_id: "DatasetId", # required
|
|
4770
|
+
# dataset_version: "DatasetVersion",
|
|
4771
|
+
# })
|
|
4772
|
+
#
|
|
4773
|
+
# @example Response structure
|
|
4774
|
+
#
|
|
4775
|
+
# resp.dataset_arn #=> String
|
|
4776
|
+
# resp.dataset_id #=> String
|
|
4777
|
+
# resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
|
|
4778
|
+
# resp.dataset_version #=> String
|
|
4779
|
+
# resp.updated_at #=> Time
|
|
4780
|
+
#
|
|
4781
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/DeleteDataset AWS API Documentation
|
|
4782
|
+
#
|
|
4783
|
+
# @overload delete_dataset(params = {})
|
|
4784
|
+
# @param [Hash] params ({})
|
|
4785
|
+
def delete_dataset(params = {}, options = {})
|
|
4786
|
+
req = build_request(:delete_dataset, params)
|
|
4787
|
+
req.send_request(options)
|
|
4788
|
+
end
|
|
4789
|
+
|
|
4790
|
+
# Deletes specific examples by ID from DRAFT.
|
|
4791
|
+
#
|
|
4792
|
+
# **Validation:** All example IDs are validated before any deletes
|
|
4793
|
+
# occur. If any ID does not exist in DRAFT, the entire batch is rejected
|
|
4794
|
+
# with ResourceNotFoundException — no examples are deleted
|
|
4795
|
+
# (all-or-nothing semantics).
|
|
4796
|
+
#
|
|
4797
|
+
# **Asynchronous:** Operates in-place on DRAFT. No version bump occurs.
|
|
4798
|
+
# Use CreateDatasetVersion to publish DRAFT as a new numbered version.
|
|
4799
|
+
#
|
|
4800
|
+
# **State guard:** Returns ConflictException (DATASET\_NOT\_READY) if
|
|
4801
|
+
# the dataset status is not in \{DRAFT, ACTIVE}.
|
|
4802
|
+
#
|
|
4803
|
+
# @option params [required, String] :dataset_id
|
|
4804
|
+
# The unique identifier of the dataset.
|
|
4805
|
+
#
|
|
4806
|
+
# @option params [String] :client_token
|
|
4807
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
|
4808
|
+
# completes no more than one time. If you don't specify this field, a
|
|
4809
|
+
# value is randomly generated for you. If this token matches a previous
|
|
4810
|
+
# request, the service ignores the request, but doesn't return an
|
|
4811
|
+
# error. For more information, see [Ensuring idempotency][1].
|
|
4812
|
+
#
|
|
4813
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
4814
|
+
# not need to pass this option.**
|
|
4815
|
+
#
|
|
4816
|
+
#
|
|
4817
|
+
#
|
|
4818
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
|
4819
|
+
#
|
|
4820
|
+
# @option params [required, Array<String>] :example_ids
|
|
4821
|
+
# The IDs of the examples to delete.
|
|
4822
|
+
#
|
|
4823
|
+
# @return [Types::DeleteDatasetExamplesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
4824
|
+
#
|
|
4825
|
+
# * {Types::DeleteDatasetExamplesResponse#dataset_arn #dataset_arn} => String
|
|
4826
|
+
# * {Types::DeleteDatasetExamplesResponse#dataset_id #dataset_id} => String
|
|
4827
|
+
# * {Types::DeleteDatasetExamplesResponse#status #status} => String
|
|
4828
|
+
# * {Types::DeleteDatasetExamplesResponse#deleted_count #deleted_count} => Integer
|
|
4829
|
+
# * {Types::DeleteDatasetExamplesResponse#updated_at #updated_at} => Time
|
|
4830
|
+
#
|
|
4831
|
+
# @example Request syntax with placeholder values
|
|
4832
|
+
#
|
|
4833
|
+
# resp = client.delete_dataset_examples({
|
|
4834
|
+
# dataset_id: "DatasetId", # required
|
|
4835
|
+
# client_token: "ClientToken",
|
|
4836
|
+
# example_ids: ["ExampleId"], # required
|
|
4837
|
+
# })
|
|
4838
|
+
#
|
|
4839
|
+
# @example Response structure
|
|
4840
|
+
#
|
|
4841
|
+
# resp.dataset_arn #=> String
|
|
4842
|
+
# resp.dataset_id #=> String
|
|
4843
|
+
# resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
|
|
4844
|
+
# resp.deleted_count #=> Integer
|
|
4845
|
+
# resp.updated_at #=> Time
|
|
4846
|
+
#
|
|
4847
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/DeleteDatasetExamples AWS API Documentation
|
|
4848
|
+
#
|
|
4849
|
+
# @overload delete_dataset_examples(params = {})
|
|
4850
|
+
# @param [Hash] params ({})
|
|
4851
|
+
def delete_dataset_examples(params = {}, options = {})
|
|
4852
|
+
req = build_request(:delete_dataset_examples, params)
|
|
4853
|
+
req.send_request(options)
|
|
4854
|
+
end
|
|
4855
|
+
|
|
4491
4856
|
# Deletes a custom evaluator. Builtin evaluators cannot be deleted. The
|
|
4492
4857
|
# evaluator must not be referenced by any active online evaluation
|
|
4493
4858
|
# configurations.
|
|
@@ -5712,6 +6077,92 @@ module Aws::BedrockAgentCoreControl
|
|
|
5712
6077
|
req.send_request(options)
|
|
5713
6078
|
end
|
|
5714
6079
|
|
|
6080
|
+
# Retrieves dataset metadata only.
|
|
6081
|
+
#
|
|
6082
|
+
# Use `?datasetVersion=DRAFT` or `?datasetVersion=N` to retrieve a
|
|
6083
|
+
# specific version's metadata. If absent, defaults to DRAFT (the
|
|
6084
|
+
# mutable working copy). Returns ResourceNotFoundException if the
|
|
6085
|
+
# specified version is not found.
|
|
6086
|
+
#
|
|
6087
|
+
# **Initial state after CreateDataset:** When CreateDataset completes
|
|
6088
|
+
# successfully (status transitions to ACTIVE), only a DRAFT working copy
|
|
6089
|
+
# exists. No published versions exist until CreateDatasetVersion is
|
|
6090
|
+
# called. At this point draftStatus is MODIFIED because the DRAFT has
|
|
6091
|
+
# content that has never been published.
|
|
6092
|
+
#
|
|
6093
|
+
# **Default version behavior:** When `datasetVersion` is omitted, the
|
|
6094
|
+
# operation returns the DRAFT working copy. To retrieve a specific
|
|
6095
|
+
# published version, pass the version number as a string (e.g.
|
|
6096
|
+
# `?datasetVersion=1`).
|
|
6097
|
+
#
|
|
6098
|
+
# **State guard:** Allowed for all statuses including DELETING. Returns
|
|
6099
|
+
# the dataset record with its current status so callers can observe the
|
|
6100
|
+
# deletion in progress.
|
|
6101
|
+
#
|
|
6102
|
+
# For paginated example IDs use ListDatasetExamples.
|
|
6103
|
+
#
|
|
6104
|
+
# @option params [required, String] :dataset_id
|
|
6105
|
+
# The unique identifier of the dataset to retrieve.
|
|
6106
|
+
#
|
|
6107
|
+
# @option params [String] :dataset_version
|
|
6108
|
+
# Version to retrieve: "DRAFT" or a version number. Defaults to DRAFT if
|
|
6109
|
+
# absent.
|
|
6110
|
+
#
|
|
6111
|
+
# @return [Types::GetDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
6112
|
+
#
|
|
6113
|
+
# * {Types::GetDatasetResponse#dataset_arn #dataset_arn} => String
|
|
6114
|
+
# * {Types::GetDatasetResponse#dataset_id #dataset_id} => String
|
|
6115
|
+
# * {Types::GetDatasetResponse#dataset_version #dataset_version} => String
|
|
6116
|
+
# * {Types::GetDatasetResponse#dataset_name #dataset_name} => String
|
|
6117
|
+
# * {Types::GetDatasetResponse#description #description} => String
|
|
6118
|
+
# * {Types::GetDatasetResponse#status #status} => String
|
|
6119
|
+
# * {Types::GetDatasetResponse#draft_status #draft_status} => String
|
|
6120
|
+
# * {Types::GetDatasetResponse#failure_reason #failure_reason} => String
|
|
6121
|
+
# * {Types::GetDatasetResponse#schema_type #schema_type} => String
|
|
6122
|
+
# * {Types::GetDatasetResponse#kms_key_arn #kms_key_arn} => String
|
|
6123
|
+
# * {Types::GetDatasetResponse#example_count #example_count} => Integer
|
|
6124
|
+
# * {Types::GetDatasetResponse#download_url #download_url} => String
|
|
6125
|
+
# * {Types::GetDatasetResponse#download_url_expires_at #download_url_expires_at} => Time
|
|
6126
|
+
# * {Types::GetDatasetResponse#created_at #created_at} => Time
|
|
6127
|
+
# * {Types::GetDatasetResponse#updated_at #updated_at} => Time
|
|
6128
|
+
# * {Types::GetDatasetResponse#tags #tags} => Hash<String,String>
|
|
6129
|
+
#
|
|
6130
|
+
# @example Request syntax with placeholder values
|
|
6131
|
+
#
|
|
6132
|
+
# resp = client.get_dataset({
|
|
6133
|
+
# dataset_id: "DatasetId", # required
|
|
6134
|
+
# dataset_version: "DatasetVersion",
|
|
6135
|
+
# })
|
|
6136
|
+
#
|
|
6137
|
+
# @example Response structure
|
|
6138
|
+
#
|
|
6139
|
+
# resp.dataset_arn #=> String
|
|
6140
|
+
# resp.dataset_id #=> String
|
|
6141
|
+
# resp.dataset_version #=> String
|
|
6142
|
+
# resp.dataset_name #=> String
|
|
6143
|
+
# resp.description #=> String
|
|
6144
|
+
# resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
|
|
6145
|
+
# resp.draft_status #=> String, one of "MODIFIED", "UNMODIFIED"
|
|
6146
|
+
# resp.failure_reason #=> String
|
|
6147
|
+
# resp.schema_type #=> String, one of "AGENTCORE_EVALUATION_PREDEFINED_V1", "AGENTCORE_EVALUATION_SIMULATED_V1"
|
|
6148
|
+
# resp.kms_key_arn #=> String
|
|
6149
|
+
# resp.example_count #=> Integer
|
|
6150
|
+
# resp.download_url #=> String
|
|
6151
|
+
# resp.download_url_expires_at #=> Time
|
|
6152
|
+
# resp.created_at #=> Time
|
|
6153
|
+
# resp.updated_at #=> Time
|
|
6154
|
+
# resp.tags #=> Hash
|
|
6155
|
+
# resp.tags["TagKey"] #=> String
|
|
6156
|
+
#
|
|
6157
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/GetDataset AWS API Documentation
|
|
6158
|
+
#
|
|
6159
|
+
# @overload get_dataset(params = {})
|
|
6160
|
+
# @param [Hash] params ({})
|
|
6161
|
+
def get_dataset(params = {}, options = {})
|
|
6162
|
+
req = build_request(:get_dataset, params)
|
|
6163
|
+
req.send_request(options)
|
|
6164
|
+
end
|
|
6165
|
+
|
|
5715
6166
|
# Retrieves detailed information about an evaluator, including its
|
|
5716
6167
|
# configuration, status, and metadata. Works with both built-in and
|
|
5717
6168
|
# custom evaluators.
|
|
@@ -7843,6 +8294,164 @@ module Aws::BedrockAgentCoreControl
|
|
|
7843
8294
|
req.send_request(options)
|
|
7844
8295
|
end
|
|
7845
8296
|
|
|
8297
|
+
# Returns paginated examples from the dataset.
|
|
8298
|
+
#
|
|
8299
|
+
# **Version-pinned pagination:** The server embeds the resolved version
|
|
8300
|
+
# in the `nextToken`. Once pagination begins, all subsequent pages are
|
|
8301
|
+
# pinned to that version regardless of concurrent mutations or whether
|
|
8302
|
+
# `datasetVersion` is passed on subsequent requests. The
|
|
8303
|
+
# `datasetVersion` query parameter is only used for the first request
|
|
8304
|
+
# (when `nextToken` is absent); if omitted, defaults to DRAFT.
|
|
8305
|
+
#
|
|
8306
|
+
# **State guard:** Allowed for all statuses including DELETING.
|
|
8307
|
+
#
|
|
8308
|
+
# @option params [required, String] :dataset_id
|
|
8309
|
+
# The unique identifier of the dataset.
|
|
8310
|
+
#
|
|
8311
|
+
# @option params [String] :dataset_version
|
|
8312
|
+
# Version to paginate: "DRAFT" or a version number. Defaults to DRAFT if
|
|
8313
|
+
# absent. Only used on the first request (when nextToken is absent). For
|
|
8314
|
+
# subsequent pages, the version is extracted from the nextToken and this
|
|
8315
|
+
# parameter is ignored.
|
|
8316
|
+
#
|
|
8317
|
+
# @option params [Integer] :max_results
|
|
8318
|
+
# Maximum number of examples to return per page. Default: 1000. Min: 1,
|
|
8319
|
+
# max: 1000. Response size is validated against 5 MB limit after
|
|
8320
|
+
# reading. For bulk access to all examples, use the `downloadUrl` field
|
|
8321
|
+
# from GetDataset.
|
|
8322
|
+
#
|
|
8323
|
+
# @option params [String] :next_token
|
|
8324
|
+
# The token for the next page of results.
|
|
8325
|
+
#
|
|
8326
|
+
# @return [Types::ListDatasetExamplesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
8327
|
+
#
|
|
8328
|
+
# * {Types::ListDatasetExamplesResponse#dataset_arn #dataset_arn} => String
|
|
8329
|
+
# * {Types::ListDatasetExamplesResponse#dataset_id #dataset_id} => String
|
|
8330
|
+
# * {Types::ListDatasetExamplesResponse#dataset_version #dataset_version} => String
|
|
8331
|
+
# * {Types::ListDatasetExamplesResponse#examples #examples} => Array<Hash,Array,String,Numeric,Boolean>
|
|
8332
|
+
# * {Types::ListDatasetExamplesResponse#next_token #next_token} => String
|
|
8333
|
+
#
|
|
8334
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
8335
|
+
#
|
|
8336
|
+
# @example Request syntax with placeholder values
|
|
8337
|
+
#
|
|
8338
|
+
# resp = client.list_dataset_examples({
|
|
8339
|
+
# dataset_id: "DatasetId", # required
|
|
8340
|
+
# dataset_version: "DatasetVersion",
|
|
8341
|
+
# max_results: 1,
|
|
8342
|
+
# next_token: "ListDatasetExamplesRequestNextTokenString",
|
|
8343
|
+
# })
|
|
8344
|
+
#
|
|
8345
|
+
# @example Response structure
|
|
8346
|
+
#
|
|
8347
|
+
# resp.dataset_arn #=> String
|
|
8348
|
+
# resp.dataset_id #=> String
|
|
8349
|
+
# resp.dataset_version #=> String
|
|
8350
|
+
# resp.examples #=> Array
|
|
8351
|
+
# resp.next_token #=> String
|
|
8352
|
+
#
|
|
8353
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/ListDatasetExamples AWS API Documentation
|
|
8354
|
+
#
|
|
8355
|
+
# @overload list_dataset_examples(params = {})
|
|
8356
|
+
# @param [Hash] params ({})
|
|
8357
|
+
def list_dataset_examples(params = {}, options = {})
|
|
8358
|
+
req = build_request(:list_dataset_examples, params)
|
|
8359
|
+
req.send_request(options)
|
|
8360
|
+
end
|
|
8361
|
+
|
|
8362
|
+
# Lists all published versions of a dataset, sorted by version number
|
|
8363
|
+
# descending (newest first). Does not include the DRAFT working copy.
|
|
8364
|
+
#
|
|
8365
|
+
# **State guard:** Allowed for all statuses including DELETING.
|
|
8366
|
+
#
|
|
8367
|
+
# @option params [required, String] :dataset_id
|
|
8368
|
+
# The unique identifier of the dataset.
|
|
8369
|
+
#
|
|
8370
|
+
# @option params [String] :next_token
|
|
8371
|
+
# The token for the next page of results.
|
|
8372
|
+
#
|
|
8373
|
+
# @option params [Integer] :max_results
|
|
8374
|
+
# The maximum number of versions to return per page.
|
|
8375
|
+
#
|
|
8376
|
+
# @return [Types::ListDatasetVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
8377
|
+
#
|
|
8378
|
+
# * {Types::ListDatasetVersionsResponse#versions #versions} => Array<Types::DatasetVersionSummary>
|
|
8379
|
+
# * {Types::ListDatasetVersionsResponse#next_token #next_token} => String
|
|
8380
|
+
#
|
|
8381
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
8382
|
+
#
|
|
8383
|
+
# @example Request syntax with placeholder values
|
|
8384
|
+
#
|
|
8385
|
+
# resp = client.list_dataset_versions({
|
|
8386
|
+
# dataset_id: "DatasetId", # required
|
|
8387
|
+
# next_token: "String",
|
|
8388
|
+
# max_results: 1,
|
|
8389
|
+
# })
|
|
8390
|
+
#
|
|
8391
|
+
# @example Response structure
|
|
8392
|
+
#
|
|
8393
|
+
# resp.versions #=> Array
|
|
8394
|
+
# resp.versions[0].dataset_version #=> String
|
|
8395
|
+
# resp.versions[0].example_count #=> Integer
|
|
8396
|
+
# resp.versions[0].created_at #=> Time
|
|
8397
|
+
# resp.next_token #=> String
|
|
8398
|
+
#
|
|
8399
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/ListDatasetVersions AWS API Documentation
|
|
8400
|
+
#
|
|
8401
|
+
# @overload list_dataset_versions(params = {})
|
|
8402
|
+
# @param [Hash] params ({})
|
|
8403
|
+
def list_dataset_versions(params = {}, options = {})
|
|
8404
|
+
req = build_request(:list_dataset_versions, params)
|
|
8405
|
+
req.send_request(options)
|
|
8406
|
+
end
|
|
8407
|
+
|
|
8408
|
+
# Lists all datasets in the caller's account, paginated. No presigned
|
|
8409
|
+
# URLs in list results.
|
|
8410
|
+
#
|
|
8411
|
+
# @option params [String] :next_token
|
|
8412
|
+
# The token for the next page of results.
|
|
8413
|
+
#
|
|
8414
|
+
# @option params [Integer] :max_results
|
|
8415
|
+
# The maximum number of datasets to return per page.
|
|
8416
|
+
#
|
|
8417
|
+
# @return [Types::ListDatasetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
8418
|
+
#
|
|
8419
|
+
# * {Types::ListDatasetsResponse#datasets #datasets} => Array<Types::DatasetSummary>
|
|
8420
|
+
# * {Types::ListDatasetsResponse#next_token #next_token} => String
|
|
8421
|
+
#
|
|
8422
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
8423
|
+
#
|
|
8424
|
+
# @example Request syntax with placeholder values
|
|
8425
|
+
#
|
|
8426
|
+
# resp = client.list_datasets({
|
|
8427
|
+
# next_token: "ListDatasetsRequestNextTokenString",
|
|
8428
|
+
# max_results: 1,
|
|
8429
|
+
# })
|
|
8430
|
+
#
|
|
8431
|
+
# @example Response structure
|
|
8432
|
+
#
|
|
8433
|
+
# resp.datasets #=> Array
|
|
8434
|
+
# resp.datasets[0].dataset_arn #=> String
|
|
8435
|
+
# resp.datasets[0].dataset_id #=> String
|
|
8436
|
+
# resp.datasets[0].dataset_name #=> String
|
|
8437
|
+
# resp.datasets[0].description #=> String
|
|
8438
|
+
# resp.datasets[0].status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
|
|
8439
|
+
# resp.datasets[0].draft_status #=> String, one of "MODIFIED", "UNMODIFIED"
|
|
8440
|
+
# resp.datasets[0].schema_type #=> String, one of "AGENTCORE_EVALUATION_PREDEFINED_V1", "AGENTCORE_EVALUATION_SIMULATED_V1"
|
|
8441
|
+
# resp.datasets[0].example_count #=> Integer
|
|
8442
|
+
# resp.datasets[0].created_at #=> Time
|
|
8443
|
+
# resp.datasets[0].updated_at #=> Time
|
|
8444
|
+
# resp.next_token #=> String
|
|
8445
|
+
#
|
|
8446
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/ListDatasets AWS API Documentation
|
|
8447
|
+
#
|
|
8448
|
+
# @overload list_datasets(params = {})
|
|
8449
|
+
# @param [Hash] params ({})
|
|
8450
|
+
def list_datasets(params = {}, options = {})
|
|
8451
|
+
req = build_request(:list_datasets, params)
|
|
8452
|
+
req.send_request(options)
|
|
8453
|
+
end
|
|
8454
|
+
|
|
7846
8455
|
# Lists all available evaluators, including both builtin evaluators
|
|
7847
8456
|
# provided by the service and custom evaluators created by the user.
|
|
7848
8457
|
#
|
|
@@ -9869,6 +10478,143 @@ module Aws::BedrockAgentCoreControl
|
|
|
9869
10478
|
req.send_request(options)
|
|
9870
10479
|
end
|
|
9871
10480
|
|
|
10481
|
+
# Updates a dataset's metadata. Synchronous operation. Only provided
|
|
10482
|
+
# fields are updated; omitted fields remain unchanged.
|
|
10483
|
+
#
|
|
10484
|
+
# To modify dataset content, use AddDatasetExamples,
|
|
10485
|
+
# UpdateDatasetExamples, or DeleteDatasetExamples.
|
|
10486
|
+
#
|
|
10487
|
+
# Cannot update: name, schemaType, kmsKeyArn (immutable after creation).
|
|
10488
|
+
#
|
|
10489
|
+
# @option params [required, String] :dataset_id
|
|
10490
|
+
# The unique identifier of the dataset to update.
|
|
10491
|
+
#
|
|
10492
|
+
# @option params [String] :client_token
|
|
10493
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
|
10494
|
+
# completes no more than one time. If you don't specify this field, a
|
|
10495
|
+
# value is randomly generated for you. If this token matches a previous
|
|
10496
|
+
# request, the service ignores the request, but doesn't return an
|
|
10497
|
+
# error. For more information, see [Ensuring idempotency][1].
|
|
10498
|
+
#
|
|
10499
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
10500
|
+
# not need to pass this option.**
|
|
10501
|
+
#
|
|
10502
|
+
#
|
|
10503
|
+
#
|
|
10504
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
|
10505
|
+
#
|
|
10506
|
+
# @option params [String] :description
|
|
10507
|
+
# The updated description for the dataset.
|
|
10508
|
+
#
|
|
10509
|
+
# @return [Types::UpdateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
10510
|
+
#
|
|
10511
|
+
# * {Types::UpdateDatasetResponse#dataset_arn #dataset_arn} => String
|
|
10512
|
+
# * {Types::UpdateDatasetResponse#dataset_id #dataset_id} => String
|
|
10513
|
+
# * {Types::UpdateDatasetResponse#updated_at #updated_at} => Time
|
|
10514
|
+
#
|
|
10515
|
+
# @example Request syntax with placeholder values
|
|
10516
|
+
#
|
|
10517
|
+
# resp = client.update_dataset({
|
|
10518
|
+
# dataset_id: "DatasetId", # required
|
|
10519
|
+
# client_token: "ClientToken",
|
|
10520
|
+
# description: "UpdateDatasetRequestDescriptionString",
|
|
10521
|
+
# })
|
|
10522
|
+
#
|
|
10523
|
+
# @example Response structure
|
|
10524
|
+
#
|
|
10525
|
+
# resp.dataset_arn #=> String
|
|
10526
|
+
# resp.dataset_id #=> String
|
|
10527
|
+
# resp.updated_at #=> Time
|
|
10528
|
+
#
|
|
10529
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/UpdateDataset AWS API Documentation
|
|
10530
|
+
#
|
|
10531
|
+
# @overload update_dataset(params = {})
|
|
10532
|
+
# @param [Hash] params ({})
|
|
10533
|
+
def update_dataset(params = {}, options = {})
|
|
10534
|
+
req = build_request(:update_dataset, params)
|
|
10535
|
+
req.send_request(options)
|
|
10536
|
+
end
|
|
10537
|
+
|
|
10538
|
+
# Updates multiple existing examples in-place on DRAFT.
|
|
10539
|
+
#
|
|
10540
|
+
# **Validation:** All examples are validated against the dataset's
|
|
10541
|
+
# schemaType before any writes occur. If any example fails validation,
|
|
10542
|
+
# the entire batch is rejected with ValidationException — no examples
|
|
10543
|
+
# are updated (all-or-nothing semantics).
|
|
10544
|
+
#
|
|
10545
|
+
# **Asynchronous:** Operates in-place on DRAFT. No version bump occurs.
|
|
10546
|
+
# Use CreateDatasetVersion to publish DRAFT as a new numbered version.
|
|
10547
|
+
#
|
|
10548
|
+
# Fails with ResourceNotFoundException if any exampleId does not exist
|
|
10549
|
+
# in DRAFT. To add new examples, use AddDatasetExamples instead.
|
|
10550
|
+
#
|
|
10551
|
+
# **State guard:** Returns ConflictException (DATASET\_NOT\_READY) if
|
|
10552
|
+
# the dataset status is not in \{DRAFT, ACTIVE}.
|
|
10553
|
+
#
|
|
10554
|
+
# **Request size limit:** Max 5 MB total request body. Max 1000 examples
|
|
10555
|
+
# per call.
|
|
10556
|
+
#
|
|
10557
|
+
# @option params [required, String] :dataset_id
|
|
10558
|
+
# The unique identifier of the dataset.
|
|
10559
|
+
#
|
|
10560
|
+
# @option params [String] :client_token
|
|
10561
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
|
10562
|
+
# completes no more than one time. If you don't specify this field, a
|
|
10563
|
+
# value is randomly generated for you. If this token matches a previous
|
|
10564
|
+
# request, the service ignores the request, but doesn't return an
|
|
10565
|
+
# error. For more information, see [Ensuring idempotency][1].
|
|
10566
|
+
#
|
|
10567
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
10568
|
+
# not need to pass this option.**
|
|
10569
|
+
#
|
|
10570
|
+
#
|
|
10571
|
+
#
|
|
10572
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
|
10573
|
+
#
|
|
10574
|
+
# @option params [required, Array<Hash,Array,String,Numeric,Boolean>] :examples
|
|
10575
|
+
# Examples to update. Each element is a JSON object containing a
|
|
10576
|
+
# required `exampleId` string field identifying the existing example,
|
|
10577
|
+
# plus the replacement fields. The `exampleId` is extracted and removed
|
|
10578
|
+
# before persistence; the remaining document is validated against the
|
|
10579
|
+
# dataset's schemaType. Max 1000 examples per call. Total request body
|
|
10580
|
+
# must not exceed 5 MB.
|
|
10581
|
+
#
|
|
10582
|
+
# @return [Types::UpdateDatasetExamplesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
10583
|
+
#
|
|
10584
|
+
# * {Types::UpdateDatasetExamplesResponse#dataset_arn #dataset_arn} => String
|
|
10585
|
+
# * {Types::UpdateDatasetExamplesResponse#dataset_id #dataset_id} => String
|
|
10586
|
+
# * {Types::UpdateDatasetExamplesResponse#status #status} => String
|
|
10587
|
+
# * {Types::UpdateDatasetExamplesResponse#updated_count #updated_count} => Integer
|
|
10588
|
+
# * {Types::UpdateDatasetExamplesResponse#updated_at #updated_at} => Time
|
|
10589
|
+
#
|
|
10590
|
+
# @example Request syntax with placeholder values
|
|
10591
|
+
#
|
|
10592
|
+
# resp = client.update_dataset_examples({
|
|
10593
|
+
# dataset_id: "DatasetId", # required
|
|
10594
|
+
# client_token: "ClientToken",
|
|
10595
|
+
# examples: [ # required
|
|
10596
|
+
# {
|
|
10597
|
+
# },
|
|
10598
|
+
# ],
|
|
10599
|
+
# })
|
|
10600
|
+
#
|
|
10601
|
+
# @example Response structure
|
|
10602
|
+
#
|
|
10603
|
+
# resp.dataset_arn #=> String
|
|
10604
|
+
# resp.dataset_id #=> String
|
|
10605
|
+
# resp.status #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "CREATE_FAILED", "UPDATE_FAILED", "DELETE_FAILED"
|
|
10606
|
+
# resp.updated_count #=> Integer
|
|
10607
|
+
# resp.updated_at #=> Time
|
|
10608
|
+
#
|
|
10609
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-control-2023-06-05/UpdateDatasetExamples AWS API Documentation
|
|
10610
|
+
#
|
|
10611
|
+
# @overload update_dataset_examples(params = {})
|
|
10612
|
+
# @param [Hash] params ({})
|
|
10613
|
+
def update_dataset_examples(params = {}, options = {})
|
|
10614
|
+
req = build_request(:update_dataset_examples, params)
|
|
10615
|
+
req.send_request(options)
|
|
10616
|
+
end
|
|
10617
|
+
|
|
9872
10618
|
# Updates a custom evaluator's configuration, description, or
|
|
9873
10619
|
# evaluation level. Built-in evaluators cannot be updated. The evaluator
|
|
9874
10620
|
# must not be locked for modification.
|
|
@@ -13045,7 +13791,7 @@ module Aws::BedrockAgentCoreControl
|
|
|
13045
13791
|
tracer: tracer
|
|
13046
13792
|
)
|
|
13047
13793
|
context[:gem_name] = 'aws-sdk-bedrockagentcorecontrol'
|
|
13048
|
-
context[:gem_version] = '1.
|
|
13794
|
+
context[:gem_version] = '1.48.0'
|
|
13049
13795
|
Seahorse::Client::Request.new(handlers, context)
|
|
13050
13796
|
end
|
|
13051
13797
|
|