Skip to content

List Dataset Examples

bedrockagentcorecontrol_list_dataset_examples R Documentation

Returns paginated examples from the dataset

Description

Returns paginated examples from the dataset.

Version-pinned pagination: The server embeds the resolved version in the nextToken. Once pagination begins, all subsequent pages are pinned to that version regardless of concurrent mutations or whether datasetVersion is passed on subsequent requests. The datasetVersion query parameter is only used for the first request (when nextToken is absent); if omitted, defaults to DRAFT.

State guard: Allowed for all statuses including DELETING.

Usage

bedrockagentcorecontrol_list_dataset_examples(datasetId, datasetVersion,
  maxResults, nextToken)

Arguments

datasetId

[required] The unique identifier of the dataset.

datasetVersion

Version to paginate: "DRAFT" or a version number. Defaults to DRAFT if absent. Only used on the first request (when nextToken is absent). For subsequent pages, the version is extracted from the nextToken and this parameter is ignored.

maxResults

Maximum number of examples to return per page. Default: 1000. Min: 1, max: 1000. Response size is validated against 5 MB limit after reading. For bulk access to all examples, use the downloadUrl field from GetDataset.

nextToken

The token for the next page of results.

Value

A list with the following syntax:

list(
  datasetArn = "string",
  datasetId = "string",
  datasetVersion = "string",
  examples = list(
    list()
  ),
  nextToken = "string"
)

Request syntax

svc$list_dataset_examples(
  datasetId = "string",
  datasetVersion = "string",
  maxResults = 123,
  nextToken = "string"
)