aws_sdk_bedrock/client/get_model_customization_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 [`GetModelCustomizationJob`](crate::operation::get_model_customization_job::builders::GetModelCustomizationJobFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`job_identifier(impl Into<String>)`](crate::operation::get_model_customization_job::builders::GetModelCustomizationJobFluentBuilder::job_identifier) / [`set_job_identifier(Option<String>)`](crate::operation::get_model_customization_job::builders::GetModelCustomizationJobFluentBuilder::set_job_identifier):<br>required: **true**<br><p>Identifier for the customization job.</p><br>
7 /// - On success, responds with [`GetModelCustomizationJobOutput`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput) with field(s):
8 /// - [`job_arn(String)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::job_arn): <p>The Amazon Resource Name (ARN) of the customization job.</p>
9 /// - [`job_name(String)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::job_name): <p>The name of the customization job.</p>
10 /// - [`output_model_name(String)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::output_model_name): <p>The name of the output model.</p>
11 /// - [`output_model_arn(Option<String>)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::output_model_arn): <p>The Amazon Resource Name (ARN) of the output model.</p>
12 /// - [`client_request_token(Option<String>)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::client_request_token): <p>The token that you specified in the <code>CreateCustomizationJob</code> request.</p>
13 /// - [`role_arn(String)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::role_arn): <p>The Amazon Resource Name (ARN) of the IAM role.</p>
14 /// - [`status(Option<ModelCustomizationJobStatus>)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::status): <p>The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use. If the job failed, the failure message contains information about why the job failed.</p>
15 /// - [`status_details(Option<StatusDetails>)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::status_details): <p>For a Distillation job, the details about the statuses of the sub-tasks of the customization job.</p>
16 /// - [`failure_message(Option<String>)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::failure_message): <p>Information about why the job failed.</p>
17 /// - [`creation_time(DateTime)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::creation_time): <p>Time that the resource was created.</p>
18 /// - [`last_modified_time(Option<DateTime>)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::last_modified_time): <p>Time that the resource was last modified.</p>
19 /// - [`end_time(Option<DateTime>)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::end_time): <p>Time that the resource transitioned to terminal state.</p>
20 /// - [`base_model_arn(String)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::base_model_arn): <p>Amazon Resource Name (ARN) of the base model.</p>
21 /// - [`hyper_parameters(Option<HashMap::<String, String>>)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::hyper_parameters): <p>The hyperparameter values for the job. For details on the format for different models, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html">Custom model hyperparameters</a>.</p>
22 /// - [`training_data_config(Option<TrainingDataConfig>)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::training_data_config): <p>Contains information about the training dataset.</p>
23 /// - [`validation_data_config(Option<ValidationDataConfig>)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::validation_data_config): <p>Contains information about the validation dataset.</p>
24 /// - [`output_data_config(Option<OutputDataConfig>)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::output_data_config): <p>Output data configuration</p>
25 /// - [`customization_type(Option<CustomizationType>)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::customization_type): <p>The type of model customization.</p>
26 /// - [`output_model_kms_key_arn(Option<String>)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::output_model_kms_key_arn): <p>The custom model is encrypted at rest using this key.</p>
27 /// - [`training_metrics(Option<TrainingMetrics>)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::training_metrics): <p>Contains training metrics from the job creation.</p>
28 /// - [`validation_metrics(Option<Vec::<ValidatorMetric>>)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::validation_metrics): <p>The loss metric for each validator that you provided in the createjob request.</p>
29 /// - [`vpc_config(Option<VpcConfig>)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::vpc_config): <p>VPC configuration for the custom model job.</p>
30 /// - [`customization_config(Option<CustomizationConfig>)`](crate::operation::get_model_customization_job::GetModelCustomizationJobOutput::customization_config): <p>The customization configuration for the model customization job.</p>
31 /// - On failure, responds with [`SdkError<GetModelCustomizationJobError>`](crate::operation::get_model_customization_job::GetModelCustomizationJobError)
32 pub fn get_model_customization_job(&self) -> crate::operation::get_model_customization_job::builders::GetModelCustomizationJobFluentBuilder {
33 crate::operation::get_model_customization_job::builders::GetModelCustomizationJobFluentBuilder::new(self.handle.clone())
34 }
35}