BedrockAgentCoreControl / Paginator / ListDatasets

ListDatasets

class BedrockAgentCoreControl.Paginator.ListDatasets

paginator = client.get_paginator('list_datasets')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

{
    'datasets': [
        {
            'datasetArn': 'string',
            'datasetId': 'string',
            'datasetName': 'string',
            'description': 'string',
            'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED',
            'draftStatus': 'MODIFIED'|'UNMODIFIED',
            'schemaType': 'AGENTCORE_EVALUATION_PREDEFINED_V1'|'AGENTCORE_EVALUATION_SIMULATED_V1',
            'exampleCount': 123,
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • datasets (list) –

    The list of datasets.

    • (dict) –

      Summary information about a dataset.

      • datasetArn (string) –

        The Amazon Resource Name (ARN) of the dataset.

      • datasetId (string) –

        The unique identifier of the dataset.

      • datasetName (string) –

        The name of the dataset.

      • description (string) –

        The description of the dataset.

      • status (string) –

        The current status of the dataset.

      • draftStatus (string) –

        Publish synchronization state. Only authoritative when status == ACTIVE.

      • schemaType (string) –

        The schema type of the dataset.

      • exampleCount (integer) –

        The number of examples in the dataset.

      • createdAt (datetime) –

        The timestamp when the dataset was created.

      • updatedAt (datetime) –

        The timestamp when the dataset was last updated.

  • NextToken (string) –

    A token to resume pagination.