aws_sdk_bedrockagentcorecontrol/client/
get_evaluator.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 [`GetEvaluator`](crate::operation::get_evaluator::builders::GetEvaluatorFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`evaluator_id(impl Into<String>)`](crate::operation::get_evaluator::builders::GetEvaluatorFluentBuilder::evaluator_id) / [`set_evaluator_id(Option<String>)`](crate::operation::get_evaluator::builders::GetEvaluatorFluentBuilder::set_evaluator_id):<br>required: **true**<br><p>The unique identifier of the evaluator to retrieve. Can be a built-in evaluator ID (e.g., Builtin.Helpfulness) or a custom evaluator ID.</p><br>
7    ///   - [`included_data(IncludedData)`](crate::operation::get_evaluator::builders::GetEvaluatorFluentBuilder::included_data) / [`set_included_data(Option<IncludedData>)`](crate::operation::get_evaluator::builders::GetEvaluatorFluentBuilder::set_included_data):<br>required: **false**<br><p>Controls which data is returned in the response. <code>ALL_DATA</code> (default) returns the full evaluator including decrypted instructions and rating scale. For evaluators encrypted with a customer managed KMS key, this requires <code>kms:Decrypt</code> permission on the key. <code>METADATA_ONLY</code> returns evaluator metadata and model configuration without instructions or rating scale, and does not require any KMS permissions.</p><br>
8    /// - On success, responds with [`GetEvaluatorOutput`](crate::operation::get_evaluator::GetEvaluatorOutput) with field(s):
9    ///   - [`evaluator_arn(String)`](crate::operation::get_evaluator::GetEvaluatorOutput::evaluator_arn): <p>The Amazon Resource Name (ARN) of the evaluator.</p>
10    ///   - [`evaluator_id(String)`](crate::operation::get_evaluator::GetEvaluatorOutput::evaluator_id): <p>The unique identifier of the evaluator.</p>
11    ///   - [`evaluator_name(String)`](crate::operation::get_evaluator::GetEvaluatorOutput::evaluator_name): <p>The name of the evaluator.</p>
12    ///   - [`description(Option<String>)`](crate::operation::get_evaluator::GetEvaluatorOutput::description): <p>The description of the evaluator.</p>
13    ///   - [`evaluator_config(Option<EvaluatorConfig>)`](crate::operation::get_evaluator::GetEvaluatorOutput::evaluator_config): <p>The configuration of the evaluator, including LLM-as-a-Judge or code-based settings.</p>
14    ///   - [`level(EvaluatorLevel)`](crate::operation::get_evaluator::GetEvaluatorOutput::level): <p>The evaluation level (<code>TOOL_CALL</code>, <code>TRACE</code>, or <code>SESSION</code>) that determines the scope of evaluation.</p>
15    ///   - [`status(EvaluatorStatus)`](crate::operation::get_evaluator::GetEvaluatorOutput::status): <p>The current status of the evaluator.</p>
16    ///   - [`created_at(DateTime)`](crate::operation::get_evaluator::GetEvaluatorOutput::created_at): <p>The timestamp when the evaluator was created.</p>
17    ///   - [`updated_at(DateTime)`](crate::operation::get_evaluator::GetEvaluatorOutput::updated_at): <p>The timestamp when the evaluator was last updated.</p>
18    ///   - [`locked_for_modification(Option<bool>)`](crate::operation::get_evaluator::GetEvaluatorOutput::locked_for_modification): <p>Whether the evaluator is locked for modification due to being referenced by active online evaluation configurations.</p>
19    ///   - [`kms_key_arn(Option<String>)`](crate::operation::get_evaluator::GetEvaluatorOutput::kms_key_arn): <p>The Amazon Resource Name (ARN) of the customer managed KMS key used to encrypt the evaluator's sensitive data. This field is only present for evaluators encrypted with a customer managed key.</p>
20    /// - On failure, responds with [`SdkError<GetEvaluatorError>`](crate::operation::get_evaluator::GetEvaluatorError)
21    pub fn get_evaluator(&self) -> crate::operation::get_evaluator::builders::GetEvaluatorFluentBuilder {
22        crate::operation::get_evaluator::builders::GetEvaluatorFluentBuilder::new(self.handle.clone())
23    }
24}
aws_sdk_bedrockagentcorecontrol/client/get_evaluator.rs

aws_sdk_bedrockagentcorecontrol/client/
get_evaluator.rs
