BedrockAgentCoreControl / Client / list_dataset_examples

list_dataset_examples¶

BedrockAgentCoreControl.Client.list_dataset_examples(**kwargs)¶

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.

Request Syntax

response = client.list_dataset_examples(
    datasetId='string',
    datasetVersion='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

datasetId (string) –
[REQUIRED]

The unique identifier of the dataset.
datasetVersion (string) – 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 (integer) – 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 (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'datasetArn': 'string',
    'datasetId': 'string',
    'datasetVersion': 'string',
    'examples': [
        {...}|[...]|123|123.4|'string'|True|None,
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- datasetArn (string) –
  
  The Amazon Resource Name (ARN) of the dataset.
- datasetId (string) –
  
  The unique identifier of the dataset.
- datasetVersion (string) –
  
  The version returned.
- examples (list) –
  
  Paginated example content. Each element is a JSON object containing at least an exampleId field plus the schema-specific content fields.
  - (document) –
- nextToken (string) –
  
  The token for the next page of results, or null if there are no more results.

Exceptions

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