update_online_evaluation_config¶
Operation¶
update_online_evaluation_config
¶
update_online_evaluation_config(request: UpdateOnlineEvaluationConfigInput | UpdateOnlineEvaluationConfigInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateOnlineEvaluationConfigInputDict]) -> 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 |
|---|---|---|---|
request
|
UpdateOnlineEvaluationConfigInput | UpdateOnlineEvaluationConfigInputDict | 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[UpdateOnlineEvaluationConfigInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateOnlineEvaluationConfigOutput
|
An instance of |
update_online_evaluation_config
async
¶
update_online_evaluation_config(request: UpdateOnlineEvaluationConfigInput | UpdateOnlineEvaluationConfigInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateOnlineEvaluationConfigInputDict]) -> 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 |
|---|---|---|---|
request
|
UpdateOnlineEvaluationConfigInput | UpdateOnlineEvaluationConfigInputDict | 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[UpdateOnlineEvaluationConfigInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateOnlineEvaluationConfigOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
UpdateOnlineEvaluationConfigInputDict
¶
Bases: TypedDict
Dictionary form of UpdateOnlineEvaluationConfigInput.
Attributes¶
client_token
instance-attribute
¶
client_token: str | 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.
This field is autopopulated if not provided.
clustering_config
instance-attribute
¶
clustering_config: ClusteringConfig | ClusteringConfigDict | None
The updated clustering configuration for periodic batch evaluation.
data_source_config
instance-attribute
¶
data_source_config: DataSourceConfig | DataSourceConfigDict | None
The updated data source configuration specifying CloudWatch log groups and service names to monitor.
description
instance-attribute
¶
description: str | None
The updated description of the online evaluation configuration.
evaluation_execution_role_arn
instance-attribute
¶
evaluation_execution_role_arn: str | None
The updated Amazon Resource Name (ARN) of the IAM role used for evaluation execution.
evaluators
instance-attribute
¶
evaluators: Sequence[EvaluatorReference | EvaluatorReferenceDict] | None
The updated list of evaluators to apply during online evaluation.
execution_status
instance-attribute
¶
execution_status: str | None
The updated execution status to enable or disable the online evaluation.
insights
instance-attribute
¶
insights: Sequence[Insight | InsightDict] | None
The updated list of insight types to run against agent sessions.
online_evaluation_config_id
instance-attribute
¶
The unique identifier of the online evaluation configuration to update.
output_config
instance-attribute
¶
output_config: OutputConfig | OutputConfigDict | None
The configuration that specifies where evaluation results should be written for monitoring and analysis.
UpdateOnlineEvaluationConfigInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateOnlineEvaluationConfigInput structure.
Attributes¶
client_token
class-attribute
instance-attribute
¶
client_token: str | 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.
This field is autopopulated if not provided.
clustering_config
class-attribute
instance-attribute
¶
clustering_config: ClusteringConfig | None = ...
The updated clustering configuration for periodic batch evaluation.
data_source_config
class-attribute
instance-attribute
¶
data_source_config: DataSourceConfig | None = ...
The updated data source configuration specifying CloudWatch log groups and service names to monitor.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The updated description of the online evaluation configuration.
evaluation_execution_role_arn
class-attribute
instance-attribute
¶
evaluation_execution_role_arn: str | None = ...
The updated Amazon Resource Name (ARN) of the IAM role used for evaluation execution.
evaluators
class-attribute
instance-attribute
¶
evaluators: list[EvaluatorReference] | None = ...
The updated list of evaluators to apply during online evaluation.
execution_status
class-attribute
instance-attribute
¶
execution_status: str | None = ...
The updated execution status to enable or disable the online evaluation.
insights
class-attribute
instance-attribute
¶
The updated list of insight types to run against agent sessions.
online_evaluation_config_id
class-attribute
instance-attribute
¶
online_evaluation_config_id: str | None = ...
The unique identifier of the online evaluation configuration to update.
output_config
class-attribute
instance-attribute
¶
output_config: OutputConfig | None = ...
The configuration that specifies where evaluation results should be written for monitoring and analysis.
Output¶
UpdateOnlineEvaluationConfigOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateOnlineEvaluationConfigOutput structure.
Attributes¶
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 update or execution failed.
online_evaluation_config_arn
instance-attribute
¶
online_evaluation_config_arn: str
The Amazon Resource Name (ARN) of the updated online evaluation configuration.
online_evaluation_config_id
instance-attribute
¶
online_evaluation_config_id: str
The unique identifier of the updated online evaluation configuration.
response_metadata
class-attribute
instance-attribute
¶
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.