BedrockAgentCoreControl / Paginator / ListDatasetExamples

ListDatasetExamples

class BedrockAgentCoreControl.Paginator.ListDatasetExamples

paginator = client.get_paginator('list_dataset_examples')

paginate(**kwargs)

Creates an iterator that will paginate through responses from BedrockAgentCoreControl.Client.list_dataset_examples().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    datasetId='string',
    datasetVersion='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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) –

    A token to resume pagination.