BedrockAgentCoreControl / Paginator / ListEvaluators

ListEvaluators¶

class BedrockAgentCoreControl.Paginator.ListEvaluators ¶

paginator = client.get_paginator('list_evaluators')

paginate(**kwargs)¶

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

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

{
    'evaluators': [
        {
            'evaluatorArn': 'string',
            'evaluatorId': 'string',
            'evaluatorName': 'string',
            'description': 'string',
            'evaluatorType': 'Builtin'|'Custom',
            'level': 'TOOL_CALL'|'TRACE'|'SESSION',
            'status': 'ACTIVE'|'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'lockedForModification': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- evaluators (list) –
  
  The list of evaluator summaries containing basic information about each evaluator.
  - (dict) –
    
    The summary information about an evaluator, including basic metadata and status information.
    - evaluatorArn (string) –
      
      The Amazon Resource Name (ARN) of the evaluator.
    - evaluatorId (string) –
      
      The unique identifier of the evaluator.
    - evaluatorName (string) –
      
      The name of the evaluator.
    - description (string) –
      
      The description of the evaluator.
    - evaluatorType (string) –
      
      The type of evaluator, indicating whether it is a built-in evaluator provided by the service or a custom evaluator created by the user.
    - level (string) –
      
      The evaluation level ( TOOL_CALL, TRACE, or SESSION) that determines the scope of evaluation.
    - status (string) –
      
      The current status of the evaluator.
    - createdAt (datetime) –
      
      The timestamp when the evaluator was created.
    - updatedAt (datetime) –
      
      The timestamp when the evaluator was last updated.
    - lockedForModification (boolean) –
      
      Whether the evaluator is locked for modification due to being referenced by active online evaluation configurations.
- NextToken (string) –
  
  A token to resume pagination.