aws_sdk_machinelearning/client/

create_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 [`CreateBatchPrediction`](crate::operation::create_batch_prediction::builders::CreateBatchPredictionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`batch_prediction_id(impl Into<String>)`](crate::operation::create_batch_prediction::builders::CreateBatchPredictionFluentBuilder::batch_prediction_id) / [`set_batch_prediction_id(Option<String>)`](crate::operation::create_batch_prediction::builders::CreateBatchPredictionFluentBuilder::set_batch_prediction_id):<br>required: **true**<br><p>A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>.</p><br>
    ///   - [`batch_prediction_name(impl Into<String>)`](crate::operation::create_batch_prediction::builders::CreateBatchPredictionFluentBuilder::batch_prediction_name) / [`set_batch_prediction_name(Option<String>)`](crate::operation::create_batch_prediction::builders::CreateBatchPredictionFluentBuilder::set_batch_prediction_name):<br>required: **false**<br><p>A user-supplied name or description of the <code>BatchPrediction</code>. <code>BatchPredictionName</code> can only use the UTF-8 character set.</p><br>
    ///   - [`ml_model_id(impl Into<String>)`](crate::operation::create_batch_prediction::builders::CreateBatchPredictionFluentBuilder::ml_model_id) / [`set_ml_model_id(Option<String>)`](crate::operation::create_batch_prediction::builders::CreateBatchPredictionFluentBuilder::set_ml_model_id):<br>required: **true**<br><p>The ID of the <code>MLModel</code> that will generate predictions for the group of observations.</p><br>
    ///   - [`batch_prediction_data_source_id(impl Into<String>)`](crate::operation::create_batch_prediction::builders::CreateBatchPredictionFluentBuilder::batch_prediction_data_source_id) / [`set_batch_prediction_data_source_id(Option<String>)`](crate::operation::create_batch_prediction::builders::CreateBatchPredictionFluentBuilder::set_batch_prediction_data_source_id):<br>required: **true**<br><p>The ID of the <code>DataSource</code> that points to the group of observations to predict.</p><br>
    ///   - [`output_uri(impl Into<String>)`](crate::operation::create_batch_prediction::builders::CreateBatchPredictionFluentBuilder::output_uri) / [`set_output_uri(Option<String>)`](crate::operation::create_batch_prediction::builders::CreateBatchPredictionFluentBuilder::set_output_uri):<br>required: **true**<br><p>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 <code>s3 key</code> portion of the <code>outputURI</code> field: ':', '//', '/./', '/../'.</p> <p>Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the <a href="https://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>.</p><br>
    /// - On success, responds with [`CreateBatchPredictionOutput`](crate::operation::create_batch_prediction::CreateBatchPredictionOutput) with field(s):
    ///   - [`batch_prediction_id(Option<String>)`](crate::operation::create_batch_prediction::CreateBatchPredictionOutput::batch_prediction_id): <p>A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>. This value is identical to the value of the <code>BatchPredictionId</code> in the request.</p>
    /// - On failure, responds with [`SdkError<CreateBatchPredictionError>`](crate::operation::create_batch_prediction::CreateBatchPredictionError)
    pub fn create_batch_prediction(&self) -> crate::operation::create_batch_prediction::builders::CreateBatchPredictionFluentBuilder {
        crate::operation::create_batch_prediction::builders::CreateBatchPredictionFluentBuilder::new(self.handle.clone())
    }
}