Struct aws_sdk_machinelearning::client::fluent_builders::CreateBatchPrediction

pub struct CreateBatchPrediction { /* private fields */ }

Fluent builder constructing a request to CreateBatchPrediction.

Generates predictions for a group of observations. The observations to process exist in one or more data files referenced by a DataSource. This operation creates a new BatchPrediction, and uses an MLModel and the data files referenced by the DataSource as information sources.

CreateBatchPrediction is an asynchronous operation. In response to CreateBatchPrediction, Amazon Machine Learning (Amazon ML) immediately returns and sets the BatchPrediction status to PENDING. After the BatchPrediction completes, Amazon ML sets the status to COMPLETED.

You can poll for status updates by using the GetBatchPrediction operation and checking the Status parameter of the result. After the COMPLETED status appears, the results are available in the location specified by the OutputUri parameter.

Implementations

impl CreateBatchPrediction

pub async fn customize(
    self
) -> Result<CustomizableOperation<CreateBatchPrediction, AwsResponseRetryClassifier>, SdkError<CreateBatchPredictionError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<CreateBatchPredictionOutput, SdkError<CreateBatchPredictionError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn batch_prediction_id(self, input: impl Into<String>) -> Self

A user-supplied ID that uniquely identifies the BatchPrediction.

pub fn set_batch_prediction_id(self, input: Option<String>) -> Self

A user-supplied ID that uniquely identifies the BatchPrediction.

pub fn batch_prediction_name(self, input: impl Into<String>) -> Self

A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.

pub fn set_batch_prediction_name(self, input: Option<String>) -> Self

A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.

pub fn ml_model_id(self, input: impl Into<String>) -> Self

The ID of the MLModel that will generate predictions for the group of observations.

pub fn set_ml_model_id(self, input: Option<String>) -> Self

The ID of the MLModel that will generate predictions for the group of observations.

pub fn batch_prediction_data_source_id(self, input: impl Into<String>) -> Self

The ID of the DataSource that points to the group of observations to predict.

pub fn set_batch_prediction_data_source_id(self, input: Option<String>) -> Self

The ID of the DataSource that points to the group of observations to predict.

pub fn output_uri(self, input: impl Into<String>) -> Self

The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.

Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.

pub fn set_output_uri(self, input: Option<String>) -> Self

The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.

Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.

Trait Implementations

impl Clone for CreateBatchPrediction

fn clone(&self) -> CreateBatchPrediction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateBatchPrediction

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

Formats the value using the given formatter.