BedrockAgentCoreControl / Client / list_dataset_examples

list_dataset_examples¶

BedrockAgentCoreControl.Client.list_dataset_examples(**kwargs)¶

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

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; for subsequent pages, the version is extracted from the pagination token.
maxResults (integer) – Maximum number of examples to return per page.
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