BedrockAgentCoreControl / Client / list_evaluators

list_evaluators¶

BedrockAgentCoreControl.Client.list_evaluators(**kwargs)¶

Lists all available evaluators, including both builtin evaluators provided by the service and custom evaluators created by the user.

Request Syntax

response = client.list_evaluators(
    nextToken='string',
    maxResults=123
)

Parameters:

nextToken (string) – The pagination token from a previous request to retrieve the next page of results.
maxResults (integer) – The maximum number of evaluators to return in a single 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) –
  
  The pagination token to use in a subsequent request to retrieve the next page of results.

Exceptions

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