update_online_evaluation_config¶
Operation¶
async
¶
update_online_evaluation_config(input: UpdateOnlineEvaluationConfigInput, plugins: list[Plugin] | None = None) -> UpdateOnlineEvaluationConfigOutput
Updates an online evaluation configuration's settings, including rules, data sources, evaluators, and execution status. Changes take effect immediately for ongoing evaluations.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateOnlineEvaluationConfigInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
UpdateOnlineEvaluationConfigOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for UpdateOnlineEvaluationConfigInput structure.
Attributes¶
class-attribute
instance-attribute
¶
client_token: str | None = None
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.
class-attribute
instance-attribute
¶
clustering_config: ClusteringConfig | None = None
The updated clustering configuration for periodic batch evaluation.
class-attribute
instance-attribute
¶
data_source_config: DataSourceConfig | None = None
The updated data source configuration specifying CloudWatch log groups and service names to monitor.
class-attribute
instance-attribute
¶
description: str | None = field(repr=False, default=None)
The updated description of the online evaluation configuration.
class-attribute
instance-attribute
¶
evaluation_execution_role_arn: str | None = None
The updated Amazon Resource Name (ARN) of the IAM role used for evaluation execution.
class-attribute
instance-attribute
¶
evaluators: list[EvaluatorReference] | None = None
The updated list of evaluators to apply during online evaluation.
class-attribute
instance-attribute
¶
execution_status: OnlineEvaluationExecutionStatus | None = None
The updated execution status to enable or disable the online evaluation.
class-attribute
instance-attribute
¶
insights: list[Insight] | None = None
The updated list of insight types to run against agent sessions.
class-attribute
instance-attribute
¶
online_evaluation_config_id: str | None = None
The unique identifier of the online evaluation configuration to update.
Output¶
dataclass
¶
Dataclass for UpdateOnlineEvaluationConfigOutput structure.
Attributes¶
instance-attribute
¶
execution_status: OnlineEvaluationExecutionStatus
The execution status indicating whether the online evaluation is currently running.
class-attribute
instance-attribute
¶
failure_reason: str | None = None
The reason for failure if the online evaluation configuration update or execution failed.
instance-attribute
¶
online_evaluation_config_arn: str
The Amazon Resource Name (ARN) of the updated online evaluation configuration.
instance-attribute
¶
online_evaluation_config_id: str
The unique identifier of the updated online evaluation configuration.
instance-attribute
¶
status: OnlineEvaluationConfigStatus
The status of the online evaluation configuration.
instance-attribute
¶
updated_at: datetime
The timestamp when the online evaluation configuration was last updated.