aws_sdk_machinelearning/client/

get_ml_model.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetMLModel`](crate::operation::get_ml_model::builders::GetMLModelFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`ml_model_id(impl Into<String>)`](crate::operation::get_ml_model::builders::GetMLModelFluentBuilder::ml_model_id) / [`set_ml_model_id(Option<String>)`](crate::operation::get_ml_model::builders::GetMLModelFluentBuilder::set_ml_model_id):<br>required: **true**<br><p>The ID assigned to the <code>MLModel</code> at creation.</p><br>
    ///   - [`verbose(bool)`](crate::operation::get_ml_model::builders::GetMLModelFluentBuilder::verbose) / [`set_verbose(Option<bool>)`](crate::operation::get_ml_model::builders::GetMLModelFluentBuilder::set_verbose):<br>required: **false**<br><p>Specifies whether the <code>GetMLModel</code> operation should return <code>Recipe</code>.</p> <p>If true, <code>Recipe</code> is returned.</p> <p>If false, <code>Recipe</code> is not returned.</p><br>
    /// - On success, responds with [`GetMlModelOutput`](crate::operation::get_ml_model::GetMlModelOutput) with field(s):
    ///   - [`ml_model_id(Option<String>)`](crate::operation::get_ml_model::GetMlModelOutput::ml_model_id): <p>The MLModel ID, which is same as the <code>MLModelId</code> in the request.</p>
    ///   - [`training_data_source_id(Option<String>)`](crate::operation::get_ml_model::GetMlModelOutput::training_data_source_id): <p>The ID of the training <code>DataSource</code>.</p>
    ///   - [`created_by_iam_user(Option<String>)`](crate::operation::get_ml_model::GetMlModelOutput::created_by_iam_user): <p>The AWS user account from which the <code>MLModel</code> was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
    ///   - [`created_at(Option<DateTime>)`](crate::operation::get_ml_model::GetMlModelOutput::created_at): <p>The time that the <code>MLModel</code> was created. The time is expressed in epoch time.</p>
    ///   - [`last_updated_at(Option<DateTime>)`](crate::operation::get_ml_model::GetMlModelOutput::last_updated_at): <p>The time of the most recent edit to the <code>MLModel</code>. The time is expressed in epoch time.</p>
    ///   - [`name(Option<String>)`](crate::operation::get_ml_model::GetMlModelOutput::name): <p>A user-supplied name or description of the <code>MLModel</code>.</p>
    ///   - [`status(Option<EntityStatus>)`](crate::operation::get_ml_model::GetMlModelOutput::status): <p>The current status of the <code>MLModel</code>. This element can have one of the following values:</p> <ul>  <li>   <p><code>PENDING</code> - Amazon Machine Learning (Amazon ML) submitted a request to describe a <code>MLModel</code>.</p></li>  <li>   <p><code>INPROGRESS</code> - The request is processing.</p></li>  <li>   <p><code>FAILED</code> - The request did not run to completion. The ML model isn't usable.</p></li>  <li>   <p><code>COMPLETED</code> - The request completed successfully.</p></li>  <li>   <p><code>DELETED</code> - The <code>MLModel</code> is marked as deleted. It isn't usable.</p></li> </ul>
    ///   - [`size_in_bytes(Option<i64>)`](crate::operation::get_ml_model::GetMlModelOutput::size_in_bytes): <p>Long integer type that is a 64-bit signed number.</p>
    ///   - [`endpoint_info(Option<RealtimeEndpointInfo>)`](crate::operation::get_ml_model::GetMlModelOutput::endpoint_info): <p>The current endpoint of the <code>MLModel</code></p>
    ///   - [`training_parameters(Option<HashMap::<String, String>>)`](crate::operation::get_ml_model::GetMlModelOutput::training_parameters): <p>A list of the training parameters in the <code>MLModel</code>. The list is implemented as a map of key-value pairs.</p> <p>The following is the current set of training parameters:</p> <ul>  <li>   <p><code>sgd.maxMLModelSizeInBytes</code> - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.</p>   <p>The value is an integer that ranges from <code>100000</code> to <code>2147483648</code>. The default value is <code>33554432</code>.</p></li>  <li>   <p><code>sgd.maxPasses</code> - The number of times that the training process traverses the observations to build the <code>MLModel</code>. The value is an integer that ranges from <code>1</code> to <code>10000</code>. The default value is <code>10</code>.</p></li>  <li>   <p><code>sgd.shuffleType</code> - Whether Amazon ML shuffles the training data. Shuffling data improves a model's ability to find the optimal solution for a variety of data types. The valid values are <code>auto</code> and <code>none</code>. The default value is <code>none</code>. We strongly recommend that you shuffle your data.</p></li>  <li>   <p><code>sgd.l1RegularizationAmount</code> - The coefficient regularization L1 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to zero, resulting in a sparse feature set. If you use this parameter, start by specifying a small value, such as <code>1.0E-08</code>.</p>   <p>The value is a double that ranges from <code>0</code> to <code>MAX_DOUBLE</code>. The default is to not use L1 normalization. This parameter can't be used when <code>L2</code> is specified. Use this parameter sparingly.</p></li>  <li>   <p><code>sgd.l2RegularizationAmount</code> - The coefficient regularization L2 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as <code>1.0E-08</code>.</p>   <p>The value is a double that ranges from <code>0</code> to <code>MAX_DOUBLE</code>. The default is to not use L2 normalization. This parameter can't be used when <code>L1</code> is specified. Use this parameter sparingly.</p></li> </ul>
    ///   - [`input_data_location_s3(Option<String>)`](crate::operation::get_ml_model::GetMlModelOutput::input_data_location_s3): <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
    ///   - [`ml_model_type(Option<MlModelType>)`](crate::operation::get_ml_model::GetMlModelOutput::ml_model_type): <p>Identifies the <code>MLModel</code> category. The following are the available types:</p> <ul>  <li>   <p>REGRESSION -- Produces a numeric result. For example, "What price should a house be listed at?"</p></li>  <li>   <p>BINARY -- Produces one of two possible results. For example, "Is this an e-commerce website?"</p></li>  <li>   <p>MULTICLASS -- Produces one of several possible results. For example, "Is this a HIGH, LOW or MEDIUM risk trade?"</p></li> </ul>
    ///   - [`score_threshold(Option<f32>)`](crate::operation::get_ml_model::GetMlModelOutput::score_threshold): <p>The scoring threshold is used in binary classification <code>MLModel</code> models. It marks the boundary between a positive prediction and a negative prediction.</p> <p>Output values greater than or equal to the threshold receive a positive result from the MLModel, such as <code>true</code>. Output values less than the threshold receive a negative response from the MLModel, such as <code>false</code>.</p>
    ///   - [`score_threshold_last_updated_at(Option<DateTime>)`](crate::operation::get_ml_model::GetMlModelOutput::score_threshold_last_updated_at): <p>The time of the most recent edit to the <code>ScoreThreshold</code>. The time is expressed in epoch time.</p>
    ///   - [`log_uri(Option<String>)`](crate::operation::get_ml_model::GetMlModelOutput::log_uri): <p>A link to the file that contains logs of the <code>CreateMLModel</code> operation.</p>
    ///   - [`message(Option<String>)`](crate::operation::get_ml_model::GetMlModelOutput::message): <p>A description of the most recent details about accessing the <code>MLModel</code>.</p>
    ///   - [`compute_time(Option<i64>)`](crate::operation::get_ml_model::GetMlModelOutput::compute_time): <p>The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the <code>MLModel</code>, normalized and scaled on computation resources. <code>ComputeTime</code> is only available if the <code>MLModel</code> is in the <code>COMPLETED</code> state.</p>
    ///   - [`finished_at(Option<DateTime>)`](crate::operation::get_ml_model::GetMlModelOutput::finished_at): <p>The epoch time when Amazon Machine Learning marked the <code>MLModel</code> as <code>COMPLETED</code> or <code>FAILED</code>. <code>FinishedAt</code> is only available when the <code>MLModel</code> is in the <code>COMPLETED</code> or <code>FAILED</code> state.</p>
    ///   - [`started_at(Option<DateTime>)`](crate::operation::get_ml_model::GetMlModelOutput::started_at): <p>The epoch time when Amazon Machine Learning marked the <code>MLModel</code> as <code>INPROGRESS</code>. <code>StartedAt</code> isn't available if the <code>MLModel</code> is in the <code>PENDING</code> state.</p>
    ///   - [`recipe(Option<String>)`](crate::operation::get_ml_model::GetMlModelOutput::recipe): <p>The recipe to use when training the <code>MLModel</code>. The <code>Recipe</code> provides detailed information about the observation data to use during training, and manipulations to perform on the observation data during training.</p> <p><b>Note:</b> This parameter is provided as part of the verbose format.</p>
    ///   - [`schema(Option<String>)`](crate::operation::get_ml_model::GetMlModelOutput::schema): <p>The schema used by all of the data files referenced by the <code>DataSource</code>.</p> <p><b>Note:</b> This parameter is provided as part of the verbose format.</p>
    /// - On failure, responds with [`SdkError<GetMLModelError>`](crate::operation::get_ml_model::GetMLModelError)
    pub fn get_ml_model(&self) -> crate::operation::get_ml_model::builders::GetMLModelFluentBuilder {
        crate::operation::get_ml_model::builders::GetMLModelFluentBuilder::new(self.handle.clone())
    }
}