aws_sdk_machinelearning/client/

get_batch_prediction.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetBatchPrediction`](crate::operation::get_batch_prediction::builders::GetBatchPredictionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`batch_prediction_id(impl Into<String>)`](crate::operation::get_batch_prediction::builders::GetBatchPredictionFluentBuilder::batch_prediction_id) / [`set_batch_prediction_id(Option<String>)`](crate::operation::get_batch_prediction::builders::GetBatchPredictionFluentBuilder::set_batch_prediction_id):<br>required: **true**<br><p>An ID assigned to the <code>BatchPrediction</code> at creation.</p><br>
    /// - On success, responds with [`GetBatchPredictionOutput`](crate::operation::get_batch_prediction::GetBatchPredictionOutput) with field(s):
    ///   - [`batch_prediction_id(Option<String>)`](crate::operation::get_batch_prediction::GetBatchPredictionOutput::batch_prediction_id): <p>An ID assigned to the <code>BatchPrediction</code> at creation. This value should be identical to the value of the <code>BatchPredictionID</code> in the request.</p>
    ///   - [`ml_model_id(Option<String>)`](crate::operation::get_batch_prediction::GetBatchPredictionOutput::ml_model_id): <p>The ID of the <code>MLModel</code> that generated predictions for the <code>BatchPrediction</code> request.</p>
    ///   - [`batch_prediction_data_source_id(Option<String>)`](crate::operation::get_batch_prediction::GetBatchPredictionOutput::batch_prediction_data_source_id): <p>The ID of the <code>DataSource</code> that was used to create the <code>BatchPrediction</code>.</p>
    ///   - [`input_data_location_s3(Option<String>)`](crate::operation::get_batch_prediction::GetBatchPredictionOutput::input_data_location_s3): <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
    ///   - [`created_by_iam_user(Option<String>)`](crate::operation::get_batch_prediction::GetBatchPredictionOutput::created_by_iam_user): <p>The AWS user account that invoked the <code>BatchPrediction</code>. 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_batch_prediction::GetBatchPredictionOutput::created_at): <p>The time when the <code>BatchPrediction</code> was created. The time is expressed in epoch time.</p>
    ///   - [`last_updated_at(Option<DateTime>)`](crate::operation::get_batch_prediction::GetBatchPredictionOutput::last_updated_at): <p>The time of the most recent edit to <code>BatchPrediction</code>. The time is expressed in epoch time.</p>
    ///   - [`name(Option<String>)`](crate::operation::get_batch_prediction::GetBatchPredictionOutput::name): <p>A user-supplied name or description of the <code>BatchPrediction</code>.</p>
    ///   - [`status(Option<EntityStatus>)`](crate::operation::get_batch_prediction::GetBatchPredictionOutput::status): <p>The status of the <code>BatchPrediction</code>, which can be one of the following values:</p> <ul>  <li>   <p><code>PENDING</code> - Amazon Machine Learning (Amazon ML) submitted a request to generate batch predictions.</p></li>  <li>   <p><code>INPROGRESS</code> - The batch predictions are in progress.</p></li>  <li>   <p><code>FAILED</code> - The request to perform a batch prediction did not run to completion. It is not usable.</p></li>  <li>   <p><code>COMPLETED</code> - The batch prediction process completed successfully.</p></li>  <li>   <p><code>DELETED</code> - The <code>BatchPrediction</code> is marked as deleted. It is not usable.</p></li> </ul>
    ///   - [`output_uri(Option<String>)`](crate::operation::get_batch_prediction::GetBatchPredictionOutput::output_uri): <p>The location of an Amazon S3 bucket or directory to receive the operation results.</p>
    ///   - [`log_uri(Option<String>)`](crate::operation::get_batch_prediction::GetBatchPredictionOutput::log_uri): <p>A link to the file that contains logs of the <code>CreateBatchPrediction</code> operation.</p>
    ///   - [`message(Option<String>)`](crate::operation::get_batch_prediction::GetBatchPredictionOutput::message): <p>A description of the most recent details about processing the batch prediction request.</p>
    ///   - [`compute_time(Option<i64>)`](crate::operation::get_batch_prediction::GetBatchPredictionOutput::compute_time): <p>The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the <code>BatchPrediction</code>, normalized and scaled on computation resources. <code>ComputeTime</code> is only available if the <code>BatchPrediction</code> is in the <code>COMPLETED</code> state.</p>
    ///   - [`finished_at(Option<DateTime>)`](crate::operation::get_batch_prediction::GetBatchPredictionOutput::finished_at): <p>The epoch time when Amazon Machine Learning marked the <code>BatchPrediction</code> as <code>COMPLETED</code> or <code>FAILED</code>. <code>FinishedAt</code> is only available when the <code>BatchPrediction</code> is in the <code>COMPLETED</code> or <code>FAILED</code> state.</p>
    ///   - [`started_at(Option<DateTime>)`](crate::operation::get_batch_prediction::GetBatchPredictionOutput::started_at): <p>The epoch time when Amazon Machine Learning marked the <code>BatchPrediction</code> as <code>INPROGRESS</code>. <code>StartedAt</code> isn't available if the <code>BatchPrediction</code> is in the <code>PENDING</code> state.</p>
    ///   - [`total_record_count(Option<i64>)`](crate::operation::get_batch_prediction::GetBatchPredictionOutput::total_record_count): <p>The number of total records that Amazon Machine Learning saw while processing the <code>BatchPrediction</code>.</p>
    ///   - [`invalid_record_count(Option<i64>)`](crate::operation::get_batch_prediction::GetBatchPredictionOutput::invalid_record_count): <p>The number of invalid records that Amazon Machine Learning saw while processing the <code>BatchPrediction</code>.</p>
    /// - On failure, responds with [`SdkError<GetBatchPredictionError>`](crate::operation::get_batch_prediction::GetBatchPredictionError)
    pub fn get_batch_prediction(&self) -> crate::operation::get_batch_prediction::builders::GetBatchPredictionFluentBuilder {
        crate::operation::get_batch_prediction::builders::GetBatchPredictionFluentBuilder::new(self.handle.clone())
    }
}