get_online_evaluation_config¶
Operation¶
async
¶
get_online_evaluation_config(input: GetOnlineEvaluationConfigInput, plugins: list[Plugin] | None = None) -> GetOnlineEvaluationConfigOutput
Retrieves detailed information about an online evaluation configuration, including its rules, data sources, evaluators, and execution status.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetOnlineEvaluationConfigInput
|
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 |
|---|---|
GetOnlineEvaluationConfigOutput
|
An instance of |
Input¶
dataclass
¶
Output¶
dataclass
¶
Dataclass for GetOnlineEvaluationConfigOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
clustering_config: ClusteringConfig | None = None
The clustering configuration for periodic batch evaluation.
instance-attribute
¶
created_at: datetime
The timestamp when the online evaluation configuration was created.
instance-attribute
¶
data_source_config: DataSourceConfig
The 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 description of the online evaluation configuration.
class-attribute
instance-attribute
¶
evaluation_execution_role_arn: str | None = None
The Amazon Resource Name (ARN) of the IAM role used for evaluation execution.
class-attribute
instance-attribute
¶
evaluators: list[EvaluatorReference] = field(default_factory=list[EvaluatorReference])
The list of evaluators applied during online evaluation.
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 execution failed.
class-attribute
instance-attribute
¶
insights: list[Insight] | None = None
The list of insight types configured for this evaluation.
instance-attribute
¶
online_evaluation_config_arn: str
The Amazon Resource Name (ARN) of the online evaluation configuration.
instance-attribute
¶
online_evaluation_config_id: str
The unique identifier of the online evaluation configuration.
instance-attribute
¶
online_evaluation_config_name: str
The name of the online evaluation configuration.
class-attribute
instance-attribute
¶
output_config: OutputConfig | None = None
The output configuration specifying where evaluation results are written.
instance-attribute
¶
rule: Rule
The evaluation rule containing sampling configuration, filters, and session settings.
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.