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

ListDatasetExamples

Returns paginated examples from the dataset. The server embeds the resolved version in the pagination token. Once pagination begins, all subsequent pages are pinned to that version regardless of concurrent mutations.

Request Syntax


GET /datasets/datasetId/examples?datasetVersion=datasetVersion&maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

datasetId

The unique identifier of the dataset.

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

Required: Yes

datasetVersion

Version to paginate: "DRAFT" or a version number. Defaults to DRAFT if absent. Only used on the first request; for subsequent pages, the version is extracted from the pagination token.

Pattern: (DRAFT|[0-9]+)

maxResults

Maximum number of examples to return per page.

Valid Range: Minimum value of 1. Maximum value of 1000.

nextToken

The token for the next page of results.

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "datasetArn": "string",
   "datasetId": "string",
   "datasetVersion": "string",
   "examples": [ JSON value ],
   "nextToken": "string"
}

Response Elements

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

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

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}

datasetVersion

The version returned.

Type: String

Pattern: (DRAFT|[0-9]+)

examples

Paginated example content. Each element is a JSON object containing at least an exampleId field plus the schema-specific content fields.

Type: Array of JSON values

nextToken

The token for the next page of results, or null if there are no more results.

Type: String

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

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