2026/09/03 - Amazon Bedrock AgentCore Control - 5 new3 updated api methods
Changes Adds log group name prefix trace source selection, custom or source log group result destinations, and metrics namespace customization
Updates an existing consent portal.
See also: AWS API Documentation
Request Syntax
client.update_consent_portal(
consentPortalIdentifier='string',
executionRoleArn='string',
idpConfig={
'credentialProviderArn': 'string',
'scopes': [
'string',
],
'audience': 'string'
},
description='string'
)
string
[REQUIRED]
The identifier of the consent portal. You can specify either the consent portal ID or its Amazon Resource Name (ARN).
string
The Amazon Resource Name (ARN) of the IAM role that the consent portal assumes to access the resources defined in its sources.
dict
The identity provider configuration that the consent portal uses to authenticate end users.
credentialProviderArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the OAuth2 credential provider used to authenticate end users to the consent portal.
scopes (list) -- [REQUIRED]
The OAuth2 scopes that the consent portal requests when authenticating end users.
(string) --
audience (string) --
The audience value that the consent portal includes when requesting tokens from the identity provider.
string
The description of the consent portal.
dict
Response Syntax
{
'sources': [
{
'identifier': 'string',
'type': 'agentcore-gateway'
},
],
'consentPortalArn': 'string',
'consentPortalId': 'string',
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'executionRoleArn': 'string',
'idpConfig': {
'credentialProviderArn': 'string',
'scopes': [
'string',
],
'audience': 'string'
},
'name': 'string',
'portalUrl': 'string',
'status': 'CREATING'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'FAILED',
'statusReason': 'string',
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
sources (list) --
The resources served by the consent portal.
(dict) --
A resource served by the consent portal.
identifier (string) --
The identifier of the source resource. For an agentcore-gateway source, this is the gateway ID or its Amazon Resource Name (ARN).
type (string) --
The type of the source resource.
consentPortalArn (string) --
The Amazon Resource Name (ARN) of the consent portal.
consentPortalId (string) --
The unique identifier of the consent portal.
createdAt (datetime) --
The timestamp for when the consent portal was created.
description (string) --
The description of the consent portal.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that the consent portal assumes to access the resources defined in its sources.
idpConfig (dict) --
The identity provider configuration that the consent portal uses to authenticate end users.
credentialProviderArn (string) --
The Amazon Resource Name (ARN) of the OAuth2 credential provider used to authenticate end users to the consent portal.
scopes (list) --
The OAuth2 scopes that the consent portal requests when authenticating end users.
(string) --
audience (string) --
The audience value that the consent portal includes when requesting tokens from the identity provider.
name (string) --
The name of the consent portal.
portalUrl (string) --
The URL used to access the consent portal.
status (string) --
The current status of the consent portal.
statusReason (string) --
A message that provides additional information about the current status of the consent portal.
updatedAt (datetime) --
The timestamp for when the consent portal was last updated.
Lists all of the consent portals in your account.
See also: AWS API Documentation
Request Syntax
client.list_consent_portals(
maxResults=123,
nextToken='string'
)
integer
The maximum number of consent portals to return in a single call.
string
A token to retrieve the next page of results. Use the value returned in a previous response to request the next page.
dict
Response Syntax
{
'consentPortals': [
{
'sources': [
{
'identifier': 'string',
'type': 'agentcore-gateway'
},
],
'consentPortalArn': 'string',
'consentPortalId': 'string',
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'name': 'string',
'portalUrl': 'string',
'status': 'CREATING'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'FAILED',
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
consentPortals (list) --
The list of consent portals.
(dict) --
Summary information about a consent portal.
sources (list) --
The resources served by the consent portal.
(dict) --
A resource served by the consent portal.
identifier (string) --
The identifier of the source resource. For an agentcore-gateway source, this is the gateway ID or its Amazon Resource Name (ARN).
type (string) --
The type of the source resource.
consentPortalArn (string) --
The Amazon Resource Name (ARN) of the consent portal.
consentPortalId (string) --
The unique identifier of the consent portal.
createdAt (datetime) --
The timestamp for when the consent portal was created.
description (string) --
The description of the consent portal.
name (string) --
The name of the consent portal.
portalUrl (string) --
The URL used to access the consent portal.
status (string) --
The current status of the consent portal.
updatedAt (datetime) --
The timestamp for when the consent portal was last updated.
nextToken (string) --
The token to use in a subsequent request to retrieve the next page of results. This value is null when there are no more results to return.
Creates a new consent portal.
See also: AWS API Documentation
Request Syntax
client.create_consent_portal(
executionRoleArn='string',
idpConfig={
'credentialProviderArn': 'string',
'scopes': [
'string',
],
'audience': 'string'
},
name='string',
sources=[
{
'identifier': 'string',
'type': 'agentcore-gateway'
},
],
description='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role that the consent portal assumes to access the resources defined in its sources.
dict
[REQUIRED]
The identity provider configuration that the consent portal uses to authenticate end users.
credentialProviderArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the OAuth2 credential provider used to authenticate end users to the consent portal.
scopes (list) -- [REQUIRED]
The OAuth2 scopes that the consent portal requests when authenticating end users.
(string) --
audience (string) --
The audience value that the consent portal includes when requesting tokens from the identity provider.
string
[REQUIRED]
The name of the consent portal. The name must be unique within your account.
list
[REQUIRED]
The resources served by the consent portal. Currently, we only support type agentcore-gateway.
(dict) --
A resource served by the consent portal.
identifier (string) -- [REQUIRED]
The identifier of the source resource. For an agentcore-gateway source, this is the gateway ID or its Amazon Resource Name (ARN).
type (string) -- [REQUIRED]
The type of the source resource.
string
The description of the consent portal.
dict
A map of tag keys and values to assign to the consent portal. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
(string) --
(string) --
dict
Response Syntax
{
'sources': [
{
'identifier': 'string',
'type': 'agentcore-gateway'
},
],
'consentPortalArn': 'string',
'consentPortalId': 'string',
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'executionRoleArn': 'string',
'idpConfig': {
'credentialProviderArn': 'string',
'scopes': [
'string',
],
'audience': 'string'
},
'name': 'string',
'portalUrl': 'string',
'status': 'CREATING'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'FAILED',
'statusReason': 'string',
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
sources (list) --
The resources served by the consent portal.
(dict) --
A resource served by the consent portal.
identifier (string) --
The identifier of the source resource. For an agentcore-gateway source, this is the gateway ID or its Amazon Resource Name (ARN).
type (string) --
The type of the source resource.
consentPortalArn (string) --
The Amazon Resource Name (ARN) of the consent portal.
consentPortalId (string) --
The unique identifier of the consent portal.
createdAt (datetime) --
The timestamp for when the consent portal was created.
description (string) --
The description of the consent portal.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that the consent portal assumes to access the resources defined in its sources.
idpConfig (dict) --
The identity provider configuration that the consent portal uses to authenticate end users.
credentialProviderArn (string) --
The Amazon Resource Name (ARN) of the OAuth2 credential provider used to authenticate end users to the consent portal.
scopes (list) --
The OAuth2 scopes that the consent portal requests when authenticating end users.
(string) --
audience (string) --
The audience value that the consent portal includes when requesting tokens from the identity provider.
name (string) --
The name of the consent portal.
portalUrl (string) --
The URL used to access the consent portal.
status (string) --
The current status of the consent portal.
statusReason (string) --
A message that provides additional information about the current status of the consent portal.
updatedAt (datetime) --
The timestamp for when the consent portal was last updated.
Retrieves information about a consent portal.
See also: AWS API Documentation
Request Syntax
client.get_consent_portal(
consentPortalIdentifier='string'
)
string
[REQUIRED]
The identifier of the consent portal. You can specify either the consent portal ID or its Amazon Resource Name (ARN).
dict
Response Syntax
{
'sources': [
{
'identifier': 'string',
'type': 'agentcore-gateway'
},
],
'consentPortalArn': 'string',
'consentPortalId': 'string',
'createdAt': datetime(2015, 1, 1),
'description': 'string',
'executionRoleArn': 'string',
'idpConfig': {
'credentialProviderArn': 'string',
'scopes': [
'string',
],
'audience': 'string'
},
'name': 'string',
'portalUrl': 'string',
'status': 'CREATING'|'ACTIVE'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'FAILED',
'statusReason': 'string',
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
sources (list) --
The resources served by the consent portal.
(dict) --
A resource served by the consent portal.
identifier (string) --
The identifier of the source resource. For an agentcore-gateway source, this is the gateway ID or its Amazon Resource Name (ARN).
type (string) --
The type of the source resource.
consentPortalArn (string) --
The Amazon Resource Name (ARN) of the consent portal.
consentPortalId (string) --
The unique identifier of the consent portal.
createdAt (datetime) --
The timestamp for when the consent portal was created.
description (string) --
The description of the consent portal.
executionRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that the consent portal assumes to access the resources defined in its sources.
idpConfig (dict) --
The identity provider configuration that the consent portal uses to authenticate end users.
credentialProviderArn (string) --
The Amazon Resource Name (ARN) of the OAuth2 credential provider used to authenticate end users to the consent portal.
scopes (list) --
The OAuth2 scopes that the consent portal requests when authenticating end users.
(string) --
audience (string) --
The audience value that the consent portal includes when requesting tokens from the identity provider.
name (string) --
The name of the consent portal.
portalUrl (string) --
The URL used to access the consent portal.
status (string) --
The current status of the consent portal.
statusReason (string) --
A message that provides additional information about the current status of the consent portal.
updatedAt (datetime) --
The timestamp for when the consent portal was last updated.
Deletes a consent portal.
See also: AWS API Documentation
Request Syntax
client.delete_consent_portal(
consentPortalIdentifier='string'
)
string
[REQUIRED]
The identifier of the consent portal. You can specify either the consent portal ID or its Amazon Resource Name (ARN).
dict
Response Syntax
{}
Response Structure
(dict) --
{'dataSourceConfig': {'cloudWatchLogs': {'logGroupNamePrefixes': ['string']}},
'outputConfig': {'cloudWatchConfig': {'logGroupName': 'string',
'metricsNamespace': 'string',
'resultDestination': 'DEDICATED_LOG_GROUP '
'| '
'SOURCE_LOG_GROUP'}}}
Response {'outputConfig': {'cloudWatchConfig': {'metricsNamespace': 'string',
'resultDestination': 'DEDICATED_LOG_GROUP '
'| '
'SOURCE_LOG_GROUP'}}}
Creates an online evaluation configuration for continuous monitoring of agent performance. Online evaluation automatically samples live traffic from CloudWatch logs at specified rates and applies evaluators to assess agent quality in production.
See also: AWS API Documentation
Request Syntax
client.create_online_evaluation_config(
clientToken='string',
onlineEvaluationConfigName='string',
description='string',
rule={
'samplingConfig': {
'samplingPercentage': 123.0
},
'filters': [
{
'key': 'string',
'operator': 'Equals'|'NotEquals'|'GreaterThan'|'LessThan'|'GreaterThanOrEqual'|'LessThanOrEqual'|'Contains'|'NotContains',
'value': {
'stringValue': 'string',
'doubleValue': 123.0,
'booleanValue': True|False
}
},
],
'sessionConfig': {
'sessionTimeoutMinutes': 123
}
},
dataSourceConfig={
'cloudWatchLogs': {
'logGroupNames': [
'string',
],
'logGroupNamePrefixes': [
'string',
],
'serviceNames': [
'string',
]
}
},
evaluators=[
{
'evaluatorId': 'string'
},
],
insights=[
{
'insightId': 'string'
},
],
clusteringConfig={
'frequencies': [
'DAILY'|'WEEKLY'|'MONTHLY',
]
},
outputConfig={
'cloudWatchConfig': {
'logGroupName': 'string',
'metricsNamespace': 'string',
'resultDestination': 'DEDICATED_LOG_GROUP'|'SOURCE_LOG_GROUP'
}
},
evaluationExecutionRoleArn='string',
enableOnCreate=True|False,
tags={
'string': 'string'
}
)
string
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the online evaluation configuration. Must be unique within your account.
string
The description of the online evaluation configuration that explains its monitoring purpose and scope.
dict
[REQUIRED]
The evaluation rule that defines sampling configuration, filters, and session detection settings for the online evaluation.
samplingConfig (dict) -- [REQUIRED]
The sampling configuration that determines what percentage of agent traces to evaluate.
samplingPercentage (float) -- [REQUIRED]
The percentage of agent traces to sample for evaluation, ranging from 0.01% to 100%.
filters (list) --
The list of filters that determine which agent traces should be included in the evaluation based on trace properties.
(dict) --
The filter that applies conditions to agent traces during online evaluation to determine which traces should be evaluated.
key (string) -- [REQUIRED]
The key or field name to filter on within the agent trace data.
operator (string) -- [REQUIRED]
The comparison operator to use for filtering.
value (dict) -- [REQUIRED]
The value to compare against using the specified operator.
stringValue (string) --
The string value for text-based filtering.
doubleValue (float) --
The numeric value for numerical filtering and comparisons.
booleanValue (boolean) --
The boolean value for true/false filtering conditions.
sessionConfig (dict) --
The session configuration that defines timeout settings for detecting when agent sessions are complete and ready for evaluation.
sessionTimeoutMinutes (integer) -- [REQUIRED]
The number of minutes of inactivity after which an agent session is considered complete and ready for evaluation. Default is 15 minutes.
dict
[REQUIRED]
The data source configuration that specifies CloudWatch log groups and service names to monitor for agent traces.
cloudWatchLogs (dict) --
The CloudWatch logs configuration for reading agent traces from log groups.
logGroupNames (list) --
The list of CloudWatch log group names to monitor for agent traces.
(string) --
logGroupNamePrefixes (list) --
The list of CloudWatch log group name prefixes to monitor for agent traces. Specify this instead of logGroupNames to match log groups by prefix. Specify either logGroupNames or logGroupNamePrefixes, not both. One of the two is required.
(string) --
Prefix of a CloudWatch Logs log group name.
serviceNames (list) -- [REQUIRED]
The list of service names to filter traces within the specified log groups. Used to identify relevant agent sessions.
(string) --
list
The list of evaluators to apply during online evaluation. Can include both built-in evaluators and custom evaluators created with CreateEvaluator.
(dict) --
The reference to an evaluator used in online evaluation configurations, containing the evaluator identifier.
evaluatorId (string) --
The unique identifier of the evaluator. Can reference builtin evaluators (e.g., Builtin.Helpfulness) or custom evaluators.
list
The list of insight types to run against agent sessions.
(dict) --
A reference to an insight analysis to run against sessions during evaluation. Insights provide deeper analysis beyond individual evaluator scores, including failure detection, user intent clustering, and execution summarization.
insightId (string) -- [REQUIRED]
The unique identifier of the insight to run.
dict
Configuration for periodic batch evaluation clustering of insight results.
frequencies (list) -- [REQUIRED]
The list of frequencies at which clustering batch evaluations are triggered.
(string) --
dict
The configuration that specifies where evaluation results should be written for monitoring and analysis.
cloudWatchConfig (dict) -- [REQUIRED]
The CloudWatch configuration for writing evaluation results to CloudWatch logs with embedded metric format.
logGroupName (string) --
The name of the CloudWatch log group where evaluation results will be written. An existing log group is used as-is; otherwise the service creates it, which requires the evaluation execution role to grant logs:CreateLogGroup on the log group. Don't specify this value when resultDestination is SOURCE_LOG_GROUP. The name can't be under the service-reserved /aws/bedrock-agentcore/evaluations/ namespace, apart from this configuration's own service-managed default group.
metricsNamespace (string) --
The CloudWatch metrics namespace where evaluation result metrics are published. If you omit this value, the service publishes metrics to Bedrock-AgentCore/Evaluations. This value can't begin with AWS/.
resultDestination (string) --
The destination where evaluation results are written. Valid values:
DEDICATED_LOG_GROUP (default) – Writes results to a dedicated result log group.
SOURCE_LOG_GROUP – Writes results back to the log group that the agent traces were read from. If you use this value, don't specify logGroupName.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM role that grants permissions to read from CloudWatch logs, write evaluation results, and invoke Amazon Bedrock models for evaluation. If the configuration references evaluators encrypted with a customer managed KMS key, this role must also have kms:Decrypt permission on the KMS key. The service validates this permission at configuration creation time. For more information, see Encryption at rest for AgentCore Evaluations.
boolean
[REQUIRED]
Whether to enable the online evaluation configuration immediately upon creation. If true, evaluation begins automatically.
dict
A map of tag keys and values to assign to an AgentCore Online Evaluation Config. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment.
(string) --
(string) --
dict
Response Syntax
{
'onlineEvaluationConfigArn': 'string',
'onlineEvaluationConfigId': 'string',
'createdAt': datetime(2015, 1, 1),
'outputConfig': {
'cloudWatchConfig': {
'logGroupName': 'string',
'metricsNamespace': 'string',
'resultDestination': 'DEDICATED_LOG_GROUP'|'SOURCE_LOG_GROUP'
}
},
'status': 'ACTIVE'|'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'ERROR',
'executionStatus': 'ENABLED'|'DISABLED',
'failureReason': 'string'
}
Response Structure
(dict) --
onlineEvaluationConfigArn (string) --
The Amazon Resource Name (ARN) of the created online evaluation configuration.
onlineEvaluationConfigId (string) --
The unique identifier of the created online evaluation configuration.
createdAt (datetime) --
The timestamp when the online evaluation configuration was created.
outputConfig (dict) --
The configuration that specifies where evaluation results should be written for monitoring and analysis.
cloudWatchConfig (dict) --
The CloudWatch configuration for writing evaluation results to CloudWatch logs with embedded metric format.
logGroupName (string) --
The name of the CloudWatch log group where evaluation results will be written. An existing log group is used as-is; otherwise the service creates it, which requires the evaluation execution role to grant logs:CreateLogGroup on the log group. Don't specify this value when resultDestination is SOURCE_LOG_GROUP. The name can't be under the service-reserved /aws/bedrock-agentcore/evaluations/ namespace, apart from this configuration's own service-managed default group.
metricsNamespace (string) --
The CloudWatch metrics namespace where evaluation result metrics are published. If you omit this value, the service publishes metrics to Bedrock-AgentCore/Evaluations. This value can't begin with AWS/.
resultDestination (string) --
The destination where evaluation results are written. Valid values:
DEDICATED_LOG_GROUP (default) – Writes results to a dedicated result log group.
SOURCE_LOG_GROUP – Writes results back to the log group that the agent traces were read from. If you use this value, don't specify logGroupName.
status (string) --
The status of the online evaluation configuration.
executionStatus (string) --
The execution status indicating whether the online evaluation is currently running.
failureReason (string) --
The reason for failure if the online evaluation configuration creation or execution failed.
{'dataSourceConfig': {'cloudWatchLogs': {'logGroupNamePrefixes': ['string']}},
'outputConfig': {'cloudWatchConfig': {'metricsNamespace': 'string',
'resultDestination': 'DEDICATED_LOG_GROUP '
'| '
'SOURCE_LOG_GROUP'}}}
Retrieves detailed information about an online evaluation configuration, including its rules, data sources, evaluators, and execution status.
See also: AWS API Documentation
Request Syntax
client.get_online_evaluation_config(
onlineEvaluationConfigId='string'
)
string
[REQUIRED]
The unique identifier of the online evaluation configuration to retrieve.
dict
Response Syntax
{
'onlineEvaluationConfigArn': 'string',
'onlineEvaluationConfigId': 'string',
'onlineEvaluationConfigName': 'string',
'description': 'string',
'rule': {
'samplingConfig': {
'samplingPercentage': 123.0
},
'filters': [
{
'key': 'string',
'operator': 'Equals'|'NotEquals'|'GreaterThan'|'LessThan'|'GreaterThanOrEqual'|'LessThanOrEqual'|'Contains'|'NotContains',
'value': {
'stringValue': 'string',
'doubleValue': 123.0,
'booleanValue': True|False
}
},
],
'sessionConfig': {
'sessionTimeoutMinutes': 123
}
},
'dataSourceConfig': {
'cloudWatchLogs': {
'logGroupNames': [
'string',
],
'logGroupNamePrefixes': [
'string',
],
'serviceNames': [
'string',
]
}
},
'evaluators': [
{
'evaluatorId': 'string'
},
],
'insights': [
{
'insightId': 'string'
},
],
'clusteringConfig': {
'frequencies': [
'DAILY'|'WEEKLY'|'MONTHLY',
]
},
'outputConfig': {
'cloudWatchConfig': {
'logGroupName': 'string',
'metricsNamespace': 'string',
'resultDestination': 'DEDICATED_LOG_GROUP'|'SOURCE_LOG_GROUP'
}
},
'evaluationExecutionRoleArn': 'string',
'status': 'ACTIVE'|'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'ERROR',
'executionStatus': 'ENABLED'|'DISABLED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'failureReason': 'string'
}
Response Structure
(dict) --
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.
rule (dict) --
The evaluation rule containing sampling configuration, filters, and session settings.
samplingConfig (dict) --
The sampling configuration that determines what percentage of agent traces to evaluate.
samplingPercentage (float) --
The percentage of agent traces to sample for evaluation, ranging from 0.01% to 100%.
filters (list) --
The list of filters that determine which agent traces should be included in the evaluation based on trace properties.
(dict) --
The filter that applies conditions to agent traces during online evaluation to determine which traces should be evaluated.
key (string) --
The key or field name to filter on within the agent trace data.
operator (string) --
The comparison operator to use for filtering.
value (dict) --
The value to compare against using the specified operator.
stringValue (string) --
The string value for text-based filtering.
doubleValue (float) --
The numeric value for numerical filtering and comparisons.
booleanValue (boolean) --
The boolean value for true/false filtering conditions.
sessionConfig (dict) --
The session configuration that defines timeout settings for detecting when agent sessions are complete and ready for evaluation.
sessionTimeoutMinutes (integer) --
The number of minutes of inactivity after which an agent session is considered complete and ready for evaluation. Default is 15 minutes.
dataSourceConfig (dict) --
The data source configuration specifying CloudWatch log groups and service names to monitor.
cloudWatchLogs (dict) --
The CloudWatch logs configuration for reading agent traces from log groups.
logGroupNames (list) --
The list of CloudWatch log group names to monitor for agent traces.
(string) --
logGroupNamePrefixes (list) --
The list of CloudWatch log group name prefixes to monitor for agent traces. Specify this instead of logGroupNames to match log groups by prefix. Specify either logGroupNames or logGroupNamePrefixes, not both. One of the two is required.
(string) --
Prefix of a CloudWatch Logs log group name.
serviceNames (list) --
The list of service names to filter traces within the specified log groups. Used to identify relevant agent sessions.
(string) --
evaluators (list) --
The list of evaluators applied during online evaluation.
(dict) --
The reference to an evaluator used in online evaluation configurations, containing the evaluator identifier.
evaluatorId (string) --
The unique identifier of the evaluator. Can reference builtin evaluators (e.g., Builtin.Helpfulness) or custom evaluators.
insights (list) --
The list of insight types configured for this evaluation.
(dict) --
A reference to an insight analysis to run against sessions during evaluation. Insights provide deeper analysis beyond individual evaluator scores, including failure detection, user intent clustering, and execution summarization.
insightId (string) --
The unique identifier of the insight to run.
clusteringConfig (dict) --
The clustering configuration for periodic batch evaluation.
frequencies (list) --
The list of frequencies at which clustering batch evaluations are triggered.
(string) --
outputConfig (dict) --
The output configuration specifying where evaluation results are written.
cloudWatchConfig (dict) --
The CloudWatch configuration for writing evaluation results to CloudWatch logs with embedded metric format.
logGroupName (string) --
The name of the CloudWatch log group where evaluation results will be written. An existing log group is used as-is; otherwise the service creates it, which requires the evaluation execution role to grant logs:CreateLogGroup on the log group. Don't specify this value when resultDestination is SOURCE_LOG_GROUP. The name can't be under the service-reserved /aws/bedrock-agentcore/evaluations/ namespace, apart from this configuration's own service-managed default group.
metricsNamespace (string) --
The CloudWatch metrics namespace where evaluation result metrics are published. If you omit this value, the service publishes metrics to Bedrock-AgentCore/Evaluations. This value can't begin with AWS/.
resultDestination (string) --
The destination where evaluation results are written. Valid values:
DEDICATED_LOG_GROUP (default) – Writes results to a dedicated result log group.
SOURCE_LOG_GROUP – Writes results back to the log group that the agent traces were read from. If you use this value, don't specify logGroupName.
evaluationExecutionRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role used for evaluation execution.
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.
{'dataSourceConfig': {'cloudWatchLogs': {'logGroupNamePrefixes': ['string']}},
'outputConfig': {'cloudWatchConfig': {'logGroupName': 'string',
'metricsNamespace': 'string',
'resultDestination': 'DEDICATED_LOG_GROUP '
'| '
'SOURCE_LOG_GROUP'}}}
Updates an online evaluation configuration's settings, including rules, data sources, evaluators, and execution status. Changes take effect immediately for ongoing evaluations.
See also: AWS API Documentation
Request Syntax
client.update_online_evaluation_config(
clientToken='string',
onlineEvaluationConfigId='string',
description='string',
rule={
'samplingConfig': {
'samplingPercentage': 123.0
},
'filters': [
{
'key': 'string',
'operator': 'Equals'|'NotEquals'|'GreaterThan'|'LessThan'|'GreaterThanOrEqual'|'LessThanOrEqual'|'Contains'|'NotContains',
'value': {
'stringValue': 'string',
'doubleValue': 123.0,
'booleanValue': True|False
}
},
],
'sessionConfig': {
'sessionTimeoutMinutes': 123
}
},
dataSourceConfig={
'cloudWatchLogs': {
'logGroupNames': [
'string',
],
'logGroupNamePrefixes': [
'string',
],
'serviceNames': [
'string',
]
}
},
evaluators=[
{
'evaluatorId': 'string'
},
],
insights=[
{
'insightId': 'string'
},
],
clusteringConfig={
'frequencies': [
'DAILY'|'WEEKLY'|'MONTHLY',
]
},
outputConfig={
'cloudWatchConfig': {
'logGroupName': 'string',
'metricsNamespace': 'string',
'resultDestination': 'DEDICATED_LOG_GROUP'|'SOURCE_LOG_GROUP'
}
},
evaluationExecutionRoleArn='string',
executionStatus='ENABLED'|'DISABLED'
)
string
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
string
[REQUIRED]
The unique identifier of the online evaluation configuration to update.
string
The updated description of the online evaluation configuration.
dict
The updated evaluation rule containing sampling configuration, filters, and session settings.
samplingConfig (dict) -- [REQUIRED]
The sampling configuration that determines what percentage of agent traces to evaluate.
samplingPercentage (float) -- [REQUIRED]
The percentage of agent traces to sample for evaluation, ranging from 0.01% to 100%.
filters (list) --
The list of filters that determine which agent traces should be included in the evaluation based on trace properties.
(dict) --
The filter that applies conditions to agent traces during online evaluation to determine which traces should be evaluated.
key (string) -- [REQUIRED]
The key or field name to filter on within the agent trace data.
operator (string) -- [REQUIRED]
The comparison operator to use for filtering.
value (dict) -- [REQUIRED]
The value to compare against using the specified operator.
stringValue (string) --
The string value for text-based filtering.
doubleValue (float) --
The numeric value for numerical filtering and comparisons.
booleanValue (boolean) --
The boolean value for true/false filtering conditions.
sessionConfig (dict) --
The session configuration that defines timeout settings for detecting when agent sessions are complete and ready for evaluation.
sessionTimeoutMinutes (integer) -- [REQUIRED]
The number of minutes of inactivity after which an agent session is considered complete and ready for evaluation. Default is 15 minutes.
dict
The updated data source configuration specifying CloudWatch log groups and service names to monitor.
cloudWatchLogs (dict) --
The CloudWatch logs configuration for reading agent traces from log groups.
logGroupNames (list) --
The list of CloudWatch log group names to monitor for agent traces.
(string) --
logGroupNamePrefixes (list) --
The list of CloudWatch log group name prefixes to monitor for agent traces. Specify this instead of logGroupNames to match log groups by prefix. Specify either logGroupNames or logGroupNamePrefixes, not both. One of the two is required.
(string) --
Prefix of a CloudWatch Logs log group name.
serviceNames (list) -- [REQUIRED]
The list of service names to filter traces within the specified log groups. Used to identify relevant agent sessions.
(string) --
list
The updated list of evaluators to apply during online evaluation.
(dict) --
The reference to an evaluator used in online evaluation configurations, containing the evaluator identifier.
evaluatorId (string) --
The unique identifier of the evaluator. Can reference builtin evaluators (e.g., Builtin.Helpfulness) or custom evaluators.
list
The updated list of insight types to run against agent sessions.
(dict) --
A reference to an insight analysis to run against sessions during evaluation. Insights provide deeper analysis beyond individual evaluator scores, including failure detection, user intent clustering, and execution summarization.
insightId (string) -- [REQUIRED]
The unique identifier of the insight to run.
dict
The updated clustering configuration for periodic batch evaluation.
frequencies (list) -- [REQUIRED]
The list of frequencies at which clustering batch evaluations are triggered.
(string) --
dict
The configuration that specifies where evaluation results should be written for monitoring and analysis.
cloudWatchConfig (dict) -- [REQUIRED]
The CloudWatch configuration for writing evaluation results to CloudWatch logs with embedded metric format.
logGroupName (string) --
The name of the CloudWatch log group where evaluation results will be written. An existing log group is used as-is; otherwise the service creates it, which requires the evaluation execution role to grant logs:CreateLogGroup on the log group. Don't specify this value when resultDestination is SOURCE_LOG_GROUP. The name can't be under the service-reserved /aws/bedrock-agentcore/evaluations/ namespace, apart from this configuration's own service-managed default group.
metricsNamespace (string) --
The CloudWatch metrics namespace where evaluation result metrics are published. If you omit this value, the service publishes metrics to Bedrock-AgentCore/Evaluations. This value can't begin with AWS/.
resultDestination (string) --
The destination where evaluation results are written. Valid values:
DEDICATED_LOG_GROUP (default) – Writes results to a dedicated result log group.
SOURCE_LOG_GROUP – Writes results back to the log group that the agent traces were read from. If you use this value, don't specify logGroupName.
string
The updated Amazon Resource Name (ARN) of the IAM role used for evaluation execution.
string
The updated execution status to enable or disable the online evaluation.
dict
Response Syntax
{
'onlineEvaluationConfigArn': 'string',
'onlineEvaluationConfigId': 'string',
'updatedAt': datetime(2015, 1, 1),
'status': 'ACTIVE'|'CREATING'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'ERROR',
'executionStatus': 'ENABLED'|'DISABLED',
'failureReason': 'string'
}
Response Structure
(dict) --
onlineEvaluationConfigArn (string) --
The Amazon Resource Name (ARN) of the updated online evaluation configuration.
onlineEvaluationConfigId (string) --
The unique identifier of the updated online evaluation configuration.
updatedAt (datetime) --
The timestamp when the online evaluation configuration was last updated.
status (string) --
The status of the online evaluation configuration.
executionStatus (string) --
The execution status indicating whether the online evaluation is currently running.
failureReason (string) --
The reason for failure if the online evaluation configuration update or execution failed.