aws_sdk_bedrock/client/get_evaluation_job.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 [`GetEvaluationJob`](crate::operation::get_evaluation_job::builders::GetEvaluationJobFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`job_identifier(impl Into<String>)`](crate::operation::get_evaluation_job::builders::GetEvaluationJobFluentBuilder::job_identifier) / [`set_job_identifier(Option<String>)`](crate::operation::get_evaluation_job::builders::GetEvaluationJobFluentBuilder::set_job_identifier):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the evaluation job you want get information on.</p><br>
7 /// - On success, responds with [`GetEvaluationJobOutput`](crate::operation::get_evaluation_job::GetEvaluationJobOutput) with field(s):
8 /// - [`job_name(String)`](crate::operation::get_evaluation_job::GetEvaluationJobOutput::job_name): <p>The name for the evaluation job.</p>
9 /// - [`status(EvaluationJobStatus)`](crate::operation::get_evaluation_job::GetEvaluationJobOutput::status): <p>The current status of the evaluation job.</p>
10 /// - [`job_arn(String)`](crate::operation::get_evaluation_job::GetEvaluationJobOutput::job_arn): <p>The Amazon Resource Name (ARN) of the evaluation job.</p>
11 /// - [`job_description(Option<String>)`](crate::operation::get_evaluation_job::GetEvaluationJobOutput::job_description): <p>The description of the evaluation job.</p>
12 /// - [`role_arn(String)`](crate::operation::get_evaluation_job::GetEvaluationJobOutput::role_arn): <p>The Amazon Resource Name (ARN) of the IAM service role used in the evaluation job.</p>
13 /// - [`customer_encryption_key_id(Option<String>)`](crate::operation::get_evaluation_job::GetEvaluationJobOutput::customer_encryption_key_id): <p>The Amazon Resource Name (ARN) of the customer managed encryption key specified when the evaluation job was created.</p>
14 /// - [`job_type(EvaluationJobType)`](crate::operation::get_evaluation_job::GetEvaluationJobOutput::job_type): <p>Specifies whether the evaluation job is automated or human-based.</p>
15 /// - [`application_type(Option<ApplicationType>)`](crate::operation::get_evaluation_job::GetEvaluationJobOutput::application_type): <p>Specifies whether the evaluation job is for evaluating a model or evaluating a knowledge base (retrieval and response generation).</p>
16 /// - [`evaluation_config(Option<EvaluationConfig>)`](crate::operation::get_evaluation_job::GetEvaluationJobOutput::evaluation_config): <p>Contains the configuration details of either an automated or human-based evaluation job.</p>
17 /// - [`inference_config(Option<EvaluationInferenceConfig>)`](crate::operation::get_evaluation_job::GetEvaluationJobOutput::inference_config): <p>Contains the configuration details of the inference model used for the evaluation job.</p>
18 /// - [`output_data_config(Option<EvaluationOutputDataConfig>)`](crate::operation::get_evaluation_job::GetEvaluationJobOutput::output_data_config): <p>Contains the configuration details of the Amazon S3 bucket for storing the results of the evaluation job.</p>
19 /// - [`creation_time(DateTime)`](crate::operation::get_evaluation_job::GetEvaluationJobOutput::creation_time): <p>The time the evaluation job was created.</p>
20 /// - [`last_modified_time(Option<DateTime>)`](crate::operation::get_evaluation_job::GetEvaluationJobOutput::last_modified_time): <p>The time the evaluation job was last modified.</p>
21 /// - [`failure_messages(Option<Vec::<String>>)`](crate::operation::get_evaluation_job::GetEvaluationJobOutput::failure_messages): <p>A list of strings that specify why the evaluation job failed to create.</p>
22 /// - On failure, responds with [`SdkError<GetEvaluationJobError>`](crate::operation::get_evaluation_job::GetEvaluationJobError)
23 pub fn get_evaluation_job(&self) -> crate::operation::get_evaluation_job::builders::GetEvaluationJobFluentBuilder {
24 crate::operation::get_evaluation_job::builders::GetEvaluationJobFluentBuilder::new(self.handle.clone())
25 }
26}