aws_sdk_bedrock/client/
get_custom_model.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 [`GetCustomModel`](crate::operation::get_custom_model::builders::GetCustomModelFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`model_identifier(impl Into<String>)`](crate::operation::get_custom_model::builders::GetCustomModelFluentBuilder::model_identifier) / [`set_model_identifier(Option<String>)`](crate::operation::get_custom_model::builders::GetCustomModelFluentBuilder::set_model_identifier):<br>required: **true**<br><p>Name or Amazon Resource Name (ARN) of the custom model.</p><br>
7    /// - On success, responds with [`GetCustomModelOutput`](crate::operation::get_custom_model::GetCustomModelOutput) with field(s):
8    ///   - [`model_arn(String)`](crate::operation::get_custom_model::GetCustomModelOutput::model_arn): <p>Amazon Resource Name (ARN) associated with this model.</p>
9    ///   - [`model_name(String)`](crate::operation::get_custom_model::GetCustomModelOutput::model_name): <p>Model name associated with this model.</p>
10    ///   - [`job_name(Option<String>)`](crate::operation::get_custom_model::GetCustomModelOutput::job_name): <p>Job name associated with this model.</p>
11    ///   - [`job_arn(Option<String>)`](crate::operation::get_custom_model::GetCustomModelOutput::job_arn): <p>Job Amazon Resource Name (ARN) associated with this model. For models that you create with the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModel.html">CreateCustomModel</a> API operation, this is <code>NULL</code>.</p>
12    ///   - [`base_model_arn(Option<String>)`](crate::operation::get_custom_model::GetCustomModelOutput::base_model_arn): <p>Amazon Resource Name (ARN) of the base model.</p>
13    ///   - [`customization_type(Option<CustomizationType>)`](crate::operation::get_custom_model::GetCustomModelOutput::customization_type): <p>The type of model customization.</p>
14    ///   - [`model_kms_key_arn(Option<String>)`](crate::operation::get_custom_model::GetCustomModelOutput::model_kms_key_arn): <p>The custom model is encrypted at rest using this key.</p>
15    ///   - [`hyper_parameters(Option<HashMap::<String, String>>)`](crate::operation::get_custom_model::GetCustomModelOutput::hyper_parameters): <p>Hyperparameter values associated with this model. 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>
16    ///   - [`training_data_config(Option<TrainingDataConfig>)`](crate::operation::get_custom_model::GetCustomModelOutput::training_data_config): <p>Contains information about the training dataset.</p>
17    ///   - [`validation_data_config(Option<ValidationDataConfig>)`](crate::operation::get_custom_model::GetCustomModelOutput::validation_data_config): <p>Contains information about the validation dataset.</p>
18    ///   - [`output_data_config(Option<OutputDataConfig>)`](crate::operation::get_custom_model::GetCustomModelOutput::output_data_config): <p>Output data configuration associated with this custom model.</p>
19    ///   - [`training_metrics(Option<TrainingMetrics>)`](crate::operation::get_custom_model::GetCustomModelOutput::training_metrics): <p>Contains training metrics from the job creation.</p>
20    ///   - [`validation_metrics(Option<Vec::<ValidatorMetric>>)`](crate::operation::get_custom_model::GetCustomModelOutput::validation_metrics): <p>The validation metrics from the job creation.</p>
21    ///   - [`creation_time(DateTime)`](crate::operation::get_custom_model::GetCustomModelOutput::creation_time): <p>Creation time of the model.</p>
22    ///   - [`customization_config(Option<CustomizationConfig>)`](crate::operation::get_custom_model::GetCustomModelOutput::customization_config): <p>The customization configuration for the custom model.</p>
23    ///   - [`model_status(Option<ModelStatus>)`](crate::operation::get_custom_model::GetCustomModelOutput::model_status): <p>The current status of the custom model. Possible values include:</p> <ul>  <li>   <p><code>Creating</code> - The model is being created and validated.</p></li>  <li>   <p><code>Active</code> - The model has been successfully created and is ready for use.</p></li>  <li>   <p><code>Failed</code> - The model creation process failed. Check the <code>failureMessage</code> field for details.</p></li> </ul>
24    ///   - [`failure_message(Option<String>)`](crate::operation::get_custom_model::GetCustomModelOutput::failure_message): <p>A failure message for any issues that occurred when creating the custom model. This is included for only a failed CreateCustomModel operation.</p>
25    /// - On failure, responds with [`SdkError<GetCustomModelError>`](crate::operation::get_custom_model::GetCustomModelError)
26    pub fn get_custom_model(&self) -> crate::operation::get_custom_model::builders::GetCustomModelFluentBuilder {
27        crate::operation::get_custom_model::builders::GetCustomModelFluentBuilder::new(self.handle.clone())
28    }
29}