aws_sdk_bedrockagentcore/client/get_batch_evaluation.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`GetBatchEvaluation`](crate::operation::get_batch_evaluation::builders::GetBatchEvaluationFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`batch_evaluation_id(impl Into<String>)`](crate::operation::get_batch_evaluation::builders::GetBatchEvaluationFluentBuilder::batch_evaluation_id) / [`set_batch_evaluation_id(Option<String>)`](crate::operation::get_batch_evaluation::builders::GetBatchEvaluationFluentBuilder::set_batch_evaluation_id):<br>required: **true**<br><p>The unique identifier of the batch evaluation to retrieve.</p><br>
7 /// - On success, responds with [`GetBatchEvaluationOutput`](crate::operation::get_batch_evaluation::GetBatchEvaluationOutput) with field(s):
8 /// - [`batch_evaluation_id(String)`](crate::operation::get_batch_evaluation::GetBatchEvaluationOutput::batch_evaluation_id): <p>The unique identifier of the batch evaluation.</p>
9 /// - [`batch_evaluation_arn(String)`](crate::operation::get_batch_evaluation::GetBatchEvaluationOutput::batch_evaluation_arn): <p>The Amazon Resource Name (ARN) of the batch evaluation.</p>
10 /// - [`batch_evaluation_name(String)`](crate::operation::get_batch_evaluation::GetBatchEvaluationOutput::batch_evaluation_name): <p>The name of the batch evaluation.</p>
11 /// - [`status(BatchEvaluationStatus)`](crate::operation::get_batch_evaluation::GetBatchEvaluationOutput::status): <p>The current status of the batch evaluation.</p>
12 /// - [`created_at(DateTime)`](crate::operation::get_batch_evaluation::GetBatchEvaluationOutput::created_at): <p>The timestamp when the batch evaluation was created.</p>
13 /// - [`evaluators(Option<Vec::<Evaluator>>)`](crate::operation::get_batch_evaluation::GetBatchEvaluationOutput::evaluators): <p>The list of evaluators applied during the batch evaluation.</p>
14 /// - [`insights(Option<Vec::<Insight>>)`](crate::operation::get_batch_evaluation::GetBatchEvaluationOutput::insights): <p>The list of insight analyses applied during the batch evaluation.</p>
15 /// - [`data_source_config(Option<DataSourceConfig>)`](crate::operation::get_batch_evaluation::GetBatchEvaluationOutput::data_source_config): <p>The data source configuration specifying where agent traces are pulled from.</p>
16 /// - [`output_config(Option<OutputConfig>)`](crate::operation::get_batch_evaluation::GetBatchEvaluationOutput::output_config): <p>The output configuration specifying where evaluation results are written.</p>
17 /// - [`evaluation_results(Option<EvaluationJobResults>)`](crate::operation::get_batch_evaluation::GetBatchEvaluationOutput::evaluation_results): <p>The aggregated evaluation results, including session completion counts and evaluator score summaries.</p>
18 /// - [`failure_analysis_result(Option<FailureAnalysisResultContent>)`](crate::operation::get_batch_evaluation::GetBatchEvaluationOutput::failure_analysis_result): <p>The failure analysis results from insights, containing categorized failure clusters with root causes and recommendations.</p>
19 /// - [`user_intent_result(Option<UserIntentClusteringResultContent>)`](crate::operation::get_batch_evaluation::GetBatchEvaluationOutput::user_intent_result): <p>The user intent clustering results from insights, containing grouped user intents across evaluated sessions.</p>
20 /// - [`execution_summary_result(Option<ExecutionSummaryClusteringResultContent>)`](crate::operation::get_batch_evaluation::GetBatchEvaluationOutput::execution_summary_result): <p>The execution summary clustering results from insights, containing grouped execution patterns across evaluated sessions.</p>
21 /// - [`error_details(Option<Vec::<String>>)`](crate::operation::get_batch_evaluation::GetBatchEvaluationOutput::error_details): <p>The error details if the batch evaluation encountered failures.</p>
22 /// - [`description(Option<String>)`](crate::operation::get_batch_evaluation::GetBatchEvaluationOutput::description): <p>The description of the batch evaluation.</p>
23 /// - [`updated_at(Option<DateTime>)`](crate::operation::get_batch_evaluation::GetBatchEvaluationOutput::updated_at): <p>The timestamp when the batch evaluation was last updated.</p>
24 /// - [`kms_key_arn(Option<String>)`](crate::operation::get_batch_evaluation::GetBatchEvaluationOutput::kms_key_arn): <p>The ARN of the KMS key used to encrypt evaluation data.</p>
25 /// - On failure, responds with [`SdkError<GetBatchEvaluationError>`](crate::operation::get_batch_evaluation::GetBatchEvaluationError)
26 pub fn get_batch_evaluation(&self) -> crate::operation::get_batch_evaluation::builders::GetBatchEvaluationFluentBuilder {
27 crate::operation::get_batch_evaluation::builders::GetBatchEvaluationFluentBuilder::new(self.handle.clone())
28 }
29}