BedrockAgentCoreControl / Client / list_online_evaluation_configs

list_online_evaluation_configs¶

BedrockAgentCoreControl.Client.list_online_evaluation_configs(**kwargs)¶

Lists all online evaluation configurations in the account, providing summary information about each configuration’s status and settings.

Request Syntax

response = client.list_online_evaluation_configs(
    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 online evaluation configurations to return in a single response.

Return type:

dict

Returns:

Response Syntax

{
    'onlineEvaluationConfigs': [
        {
            'onlineEvaluationConfigArn': 'string',
            'onlineEvaluationConfigId': 'string',
            'onlineEvaluationConfigName': 'string',
            'description': 'string',
            'status': 'ACTIVE'|'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING',
            'executionStatus': 'ENABLED'|'DISABLED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'failureReason': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- onlineEvaluationConfigs (list) –
  
  The list of online evaluation configuration summaries containing basic information about each configuration.
  - (dict) –
    
    The summary information about an online evaluation configuration, including basic metadata and execution status.
    - onlineEvaluationConfigArn (string) –
      
      The Amazon Resource Name (ARN) of the online evaluation configuration.
    - onlineEvaluationConfigId (string) –
      
      The unique identifier of the online evaluation configuration.
    - onlineEvaluationConfigName (string) –
      
      The name of the online evaluation configuration.
    - description (string) –
      
      The description of the online evaluation configuration.
    - status (string) –
      
      The status of the online evaluation configuration.
    - executionStatus (string) –
      
      The execution status indicating whether the online evaluation is currently running.
    - createdAt (datetime) –
      
      The timestamp when the online evaluation configuration was created.
    - updatedAt (datetime) –
      
      The timestamp when the online evaluation configuration was last updated.
    - failureReason (string) –
      
      The reason for failure if the online evaluation configuration execution failed.
- 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