Struct aws_sdk_machinelearning::operation::get_batch_prediction::GetBatchPredictionOutput

#[non_exhaustive]
pub struct GetBatchPredictionOutput {

    pub batch_prediction_id: Option<String>,
    pub ml_model_id: Option<String>,
    pub batch_prediction_data_source_id: Option<String>,
    pub input_data_location_s3: Option<String>,
    pub created_by_iam_user: Option<String>,
    pub created_at: Option<DateTime>,
    pub last_updated_at: Option<DateTime>,
    pub name: Option<String>,
    pub status: Option<EntityStatus>,
    pub output_uri: Option<String>,
    pub log_uri: Option<String>,
    pub message: Option<String>,
    pub compute_time: Option<i64>,
    pub finished_at: Option<DateTime>,
    pub started_at: Option<DateTime>,
    pub total_record_count: Option<i64>,
    pub invalid_record_count: Option<i64>,
    /* private fields */
}

Represents the output of a GetBatchPrediction operation and describes a BatchPrediction.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

batch_prediction_id: Option<String>

An ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.

ml_model_id: Option<String>

The ID of the MLModel that generated predictions for the BatchPrediction request.

batch_prediction_data_source_id: Option<String>

The ID of the DataSource that was used to create the BatchPrediction.

input_data_location_s3: Option<String>

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

created_by_iam_user: Option<String>

The AWS user account that invoked the BatchPrediction. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

created_at: Option<DateTime>

The time when the BatchPrediction was created. The time is expressed in epoch time.

last_updated_at: Option<DateTime>

The time of the most recent edit to BatchPrediction. The time is expressed in epoch time.

name: Option<String>

A user-supplied name or description of the BatchPrediction.

status: Option<EntityStatus>

The status of the BatchPrediction, which can be one of the following values:

• PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate batch predictions.

• INPROGRESS - The batch predictions are in progress.

• FAILED - The request to perform a batch prediction did not run to completion. It is not usable.

• COMPLETED - The batch prediction process completed successfully.

• DELETED - The BatchPrediction is marked as deleted. It is not usable.

output_uri: Option<String>

The location of an Amazon S3 bucket or directory to receive the operation results.

log_uri: Option<String>

A link to the file that contains logs of the CreateBatchPrediction operation.

message: Option<String>

A description of the most recent details about processing the batch prediction request.

compute_time: Option<i64>

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the BatchPrediction, normalized and scaled on computation resources. ComputeTime is only available if the BatchPrediction is in the COMPLETED state.

finished_at: Option<DateTime>

The epoch time when Amazon Machine Learning marked the BatchPrediction as COMPLETED or FAILED. FinishedAt is only available when the BatchPrediction is in the COMPLETED or FAILED state.

started_at: Option<DateTime>

The epoch time when Amazon Machine Learning marked the BatchPrediction as INPROGRESS. StartedAt isn't available if the BatchPrediction is in the PENDING state.

total_record_count: Option<i64>

The number of total records that Amazon Machine Learning saw while processing the BatchPrediction.

invalid_record_count: Option<i64>

The number of invalid records that Amazon Machine Learning saw while processing the BatchPrediction.

Implementations

impl GetBatchPredictionOutput

pub fn batch_prediction_id(&self) -> Option<&str>

An ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.

pub fn ml_model_id(&self) -> Option<&str>

The ID of the MLModel that generated predictions for the BatchPrediction request.

pub fn batch_prediction_data_source_id(&self) -> Option<&str>

The ID of the DataSource that was used to create the BatchPrediction.

pub fn input_data_location_s3(&self) -> Option<&str>

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

pub fn created_by_iam_user(&self) -> Option<&str>

The AWS user account that invoked the BatchPrediction. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

pub fn created_at(&self) -> Option<&DateTime>

The time when the BatchPrediction was created. The time is expressed in epoch time.

pub fn last_updated_at(&self) -> Option<&DateTime>

The time of the most recent edit to BatchPrediction. The time is expressed in epoch time.

pub fn name(&self) -> Option<&str>

A user-supplied name or description of the BatchPrediction.

pub fn status(&self) -> Option<&EntityStatus>

The status of the BatchPrediction, which can be one of the following values:

• PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate batch predictions.

• INPROGRESS - The batch predictions are in progress.

• FAILED - The request to perform a batch prediction did not run to completion. It is not usable.

• COMPLETED - The batch prediction process completed successfully.

• DELETED - The BatchPrediction is marked as deleted. It is not usable.

pub fn output_uri(&self) -> Option<&str>

The location of an Amazon S3 bucket or directory to receive the operation results.

pub fn log_uri(&self) -> Option<&str>

A link to the file that contains logs of the CreateBatchPrediction operation.

pub fn message(&self) -> Option<&str>

A description of the most recent details about processing the batch prediction request.

pub fn compute_time(&self) -> Option<i64>

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the BatchPrediction, normalized and scaled on computation resources. ComputeTime is only available if the BatchPrediction is in the COMPLETED state.

pub fn finished_at(&self) -> Option<&DateTime>

The epoch time when Amazon Machine Learning marked the BatchPrediction as COMPLETED or FAILED. FinishedAt is only available when the BatchPrediction is in the COMPLETED or FAILED state.

pub fn started_at(&self) -> Option<&DateTime>

The epoch time when Amazon Machine Learning marked the BatchPrediction as INPROGRESS. StartedAt isn't available if the BatchPrediction is in the PENDING state.

pub fn total_record_count(&self) -> Option<i64>

The number of total records that Amazon Machine Learning saw while processing the BatchPrediction.

pub fn invalid_record_count(&self) -> Option<i64>

The number of invalid records that Amazon Machine Learning saw while processing the BatchPrediction.

impl GetBatchPredictionOutput

pub fn builder() -> GetBatchPredictionOutputBuilder

Creates a new builder-style object to manufacture GetBatchPredictionOutput.

Trait Implementations

impl Clone for GetBatchPredictionOutput

fn clone(&self) -> GetBatchPredictionOutput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetBatchPredictionOutput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GetBatchPredictionOutput

fn eq(&self, other: &GetBatchPredictionOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for GetBatchPredictionOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetBatchPredictionOutput