BedrockAgentCoreControl / Client / update_dataset_examples

update_dataset_examples¶

BedrockAgentCoreControl.Client.update_dataset_examples(**kwargs)¶

Updates multiple existing examples in-place on DRAFT.

Validation: All examples are validated against the dataset’s schemaType before any writes occur. If any example fails validation, the entire batch is rejected with ValidationException — no examples are updated (all-or-nothing semantics).

Asynchronous: Operates in-place on DRAFT. No version bump occurs. Use CreateDatasetVersion to publish DRAFT as a new numbered version.

Fails with ResourceNotFoundException if any exampleId does not exist in DRAFT. To add new examples, use AddDatasetExamples instead.

State guard: Returns ConflictException (DATASET_NOT_READY) if the dataset status is not in {DRAFT, ACTIVE}.

Request size limit: Max 5 MB total request body. Max 1000 examples per call.

Request Syntax

response = client.update_dataset_examples(
    datasetId='string',
    clientToken='string',
    examples=[
        {...}|[...]|123|123.4|'string'|True|None,
    ]
)

Parameters:

datasetId (string) –
[REQUIRED]

The unique identifier of the dataset.
clientToken (string) –
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.
examples (list) –
[REQUIRED]

Examples to update. Each element is a JSON object containing a required exampleId string field identifying the existing example, plus the replacement fields. The exampleId is extracted and removed before persistence; the remaining document is validated against the dataset’s schemaType. Max 1000 examples per call. Total request body must not exceed 5 MB.
- (document) –

Return type:

dict

Returns:

Response Syntax

{
    'datasetArn': 'string',
    'datasetId': 'string',
    'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
    'updatedCount': 123,
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- datasetArn (string) –
  
  The Amazon Resource Name (ARN) of the dataset.
- datasetId (string) –
  
  The unique identifier of the dataset.
- status (string) –
  
  The current status of the dataset.
- updatedCount (integer) –
  
  The number of examples updated.
- updatedAt (datetime) –
  
  The timestamp when the examples were updated.

Exceptions

BedrockAgentCoreControl.Client.exceptions.ServiceQuotaExceededException
BedrockAgentCoreControl.Client.exceptions.ValidationException
BedrockAgentCoreControl.Client.exceptions.ConflictException
BedrockAgentCoreControl.Client.exceptions.AccessDeniedException
BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException
BedrockAgentCoreControl.Client.exceptions.ThrottlingException
BedrockAgentCoreControl.Client.exceptions.InternalServerException