Skip to content

get_online_evaluation_config

Operation

get_online_evaluation_config

get_online_evaluation_config(request: GetOnlineEvaluationConfigInput | GetOnlineEvaluationConfigInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetOnlineEvaluationConfigInputDict]) -> GetOnlineEvaluationConfigOutput

Retrieves detailed information about an online evaluation configuration, including its rules, data sources, evaluators, and execution status.

Parameters:

Name Type Description Default
request GetOnlineEvaluationConfigInput | GetOnlineEvaluationConfigInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetOnlineEvaluationConfigInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetOnlineEvaluationConfigOutput

An instance of GetOnlineEvaluationConfigOutput.

get_online_evaluation_config async

get_online_evaluation_config(request: GetOnlineEvaluationConfigInput | GetOnlineEvaluationConfigInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetOnlineEvaluationConfigInputDict]) -> GetOnlineEvaluationConfigOutput

Retrieves detailed information about an online evaluation configuration, including its rules, data sources, evaluators, and execution status.

Parameters:

Name Type Description Default
request GetOnlineEvaluationConfigInput | GetOnlineEvaluationConfigInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetOnlineEvaluationConfigInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetOnlineEvaluationConfigOutput

An instance of GetOnlineEvaluationConfigOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetOnlineEvaluationConfigInputDict

Bases: TypedDict

Dictionary form of GetOnlineEvaluationConfigInput.

Attributes

online_evaluation_config_id instance-attribute
online_evaluation_config_id: Required[str]

The unique identifier of the online evaluation configuration to retrieve.

GetOnlineEvaluationConfigInput dataclass

Bases: _SerdeShape

Dataclass for GetOnlineEvaluationConfigInput structure.

Attributes

online_evaluation_config_id class-attribute instance-attribute
online_evaluation_config_id: str | None = ...

The unique identifier of the online evaluation configuration to retrieve.

Output

GetOnlineEvaluationConfigOutput dataclass

Bases: _SerdeShape

Dataclass for GetOnlineEvaluationConfigOutput structure.

Attributes

clustering_config class-attribute instance-attribute
clustering_config: ClusteringConfig | None = ...

The clustering configuration for periodic batch evaluation.

created_at instance-attribute
created_at: datetime

The timestamp when the online evaluation configuration was created.

data_source_config instance-attribute
data_source_config: DataSourceConfig

The data source configuration specifying CloudWatch log groups and service names to monitor.

description class-attribute instance-attribute
description: str | None = ...

The description of the online evaluation configuration.

evaluation_execution_role_arn class-attribute instance-attribute
evaluation_execution_role_arn: str | None = ...

The Amazon Resource Name (ARN) of the IAM role used for evaluation execution.

evaluators class-attribute instance-attribute
evaluators: list[EvaluatorReference] = ...

The list of evaluators applied during online evaluation.

execution_status instance-attribute
execution_status: str

The execution status indicating whether the online evaluation is currently running.

failure_reason class-attribute instance-attribute
failure_reason: str | None = ...

The reason for failure if the online evaluation configuration execution failed.

insights class-attribute instance-attribute
insights: list[Insight] | None = ...

The list of insight types configured for this evaluation.

online_evaluation_config_arn instance-attribute
online_evaluation_config_arn: str

The Amazon Resource Name (ARN) of the online evaluation configuration.

online_evaluation_config_id instance-attribute
online_evaluation_config_id: str

The unique identifier of the online evaluation configuration.

online_evaluation_config_name instance-attribute
online_evaluation_config_name: str

The name of the online evaluation configuration.

output_config class-attribute instance-attribute
output_config: OutputConfig | None = ...

The output configuration specifying where evaluation results are written.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

rule instance-attribute
rule: Rule

The evaluation rule containing sampling configuration, filters, and session settings.

status instance-attribute
status: str

The status of the online evaluation configuration.

updated_at instance-attribute
updated_at: datetime

The timestamp when the online evaluation configuration was last updated.