Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

AddDatasetExamples

Adds examples to the dataset's DRAFT. All examples are validated against the dataset's schema type before any writes occur. If any example fails validation, the entire batch is rejected (all-or-nothing semantics).

Request Syntax


POST /datasets/datasetId/examples/add HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "source": { ... }
}

URI Request Parameters

The request uses the following URI parameters.

datasetId

The unique identifier of the dataset to add examples to.

Pattern: [a-zA-Z0-9_-]{1,110}

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

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.

Type: String

Length Constraints: Minimum length of 33. Maximum length of 256.

Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}

Required: No

source

Source of examples to add. Provide either inline examples or an S3 URI pointing to a JSONL file.

Type: DataSourceType object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "addedCount": number,
   "datasetArn": "string",
   "datasetId": "string",
   "exampleIds": [ "string" ],
   "status": "string",
   "updatedAt": number
}

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

addedCount

The number of examples added.

Type: Long

datasetArn

The Amazon Resource Name (ARN) of the dataset.

Type: String

Pattern: arn:aws(-[a-z]+)*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:dataset/[a-zA-Z0-9_-]{1,110}

datasetId

The unique identifier of the dataset.

Type: String

Pattern: [a-zA-Z0-9_-]{1,110}

exampleIds

IDs of all added examples (auto-generated UUIDs).

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [a-zA-Z0-9_.:-]+

status

The current status of the dataset.

Type: String

updatedAt

The timestamp when the examples were added.

Type: Timestamp

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

This exception is thrown when a request is denied per access permissions

HTTP Status Code: 403

ConflictException

This exception is thrown when there is a conflict performing an operation

HTTP Status Code: 409

InternalServerException

This exception is thrown if there was an unexpected error during processing of request

HTTP Status Code: 500

ResourceNotFoundException

This exception is thrown when a resource referenced by the operation does not exist

HTTP Status Code: 404

ServiceQuotaExceededException

This exception is thrown when a request is made beyond the service quota

HTTP Status Code: 402

ThrottlingException

This exception is thrown when the number of requests exceeds the limit

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

HTTP Status Code: 400