aws_sdk_sagemaker/client/

create_transform_job.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateTransformJob`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`transform_job_name(impl Into<String>)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::transform_job_name) / [`set_transform_job_name(Option<String>)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::set_transform_job_name):<br>required: **true**<br><p>The name of the transform job. The name must be unique within an Amazon Web Services Region in an Amazon Web Services account.</p><br>
    ///   - [`model_name(impl Into<String>)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::model_name) / [`set_model_name(Option<String>)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::set_model_name):<br>required: **true**<br><p>The name of the model that you want to use for the transform job. <code>ModelName</code> must be the name of an existing Amazon SageMaker model within an Amazon Web Services Region in an Amazon Web Services account.</p><br>
    ///   - [`max_concurrent_transforms(i32)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::max_concurrent_transforms) / [`set_max_concurrent_transforms(Option<i32>)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::set_max_concurrent_transforms):<br>required: **false**<br><p>The maximum number of parallel requests that can be sent to each instance in a transform job. If <code>MaxConcurrentTransforms</code> is set to <code>0</code> or left unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is <code>1</code>. For more information on execution-parameters, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-batch-code.html#your-algorithms-batch-code-how-containe-serves-requests">How Containers Serve Requests</a>. For built-in algorithms, you don't need to set a value for <code>MaxConcurrentTransforms</code>.</p><br>
    ///   - [`model_client_config(ModelClientConfig)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::model_client_config) / [`set_model_client_config(Option<ModelClientConfig>)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::set_model_client_config):<br>required: **false**<br><p>Configures the timeout and maximum number of retries for processing a transform job invocation.</p><br>
    ///   - [`max_payload_in_mb(i32)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::max_payload_in_mb) / [`set_max_payload_in_mb(Option<i32>)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::set_max_payload_in_mb):<br>required: **false**<br><p>The maximum allowed size of the payload, in MB. A <i>payload</i> is the data portion of a record (without metadata). The value in <code>MaxPayloadInMB</code> must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is <code>6</code> MB.</p> <p>The value of <code>MaxPayloadInMB</code> cannot be greater than 100 MB. If you specify the <code>MaxConcurrentTransforms</code> parameter, the value of <code>(MaxConcurrentTransforms * MaxPayloadInMB)</code> also cannot exceed 100 MB.</p> <p>For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to <code>0</code>. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.</p><br>
    ///   - [`batch_strategy(BatchStrategy)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::batch_strategy) / [`set_batch_strategy(Option<BatchStrategy>)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::set_batch_strategy):<br>required: **false**<br><p>Specifies the number of records to include in a mini-batch for an HTTP inference request. A <i>record</i> <i></i> is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.</p> <p>To enable the batch strategy, you must set the <code>SplitType</code> property to <code>Line</code>, <code>RecordIO</code>, or <code>TFRecord</code>.</p> <p>To use only one record when making an HTTP invocation request to a container, set <code>BatchStrategy</code> to <code>SingleRecord</code> and <code>SplitType</code> to <code>Line</code>.</p> <p>To fit as many records in a mini-batch as can fit within the <code>MaxPayloadInMB</code> limit, set <code>BatchStrategy</code> to <code>MultiRecord</code> and <code>SplitType</code> to <code>Line</code>.</p><br>
    ///   - [`environment(impl Into<String>, impl Into<String>)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::environment) / [`set_environment(Option<HashMap::<String, String>>)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::set_environment):<br>required: **false**<br><p>The environment variables to set in the Docker container. Don't include any sensitive data in your environment variables. We support up to 16 key and values entries in the map.</p><br>
    ///   - [`transform_input(TransformInput)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::transform_input) / [`set_transform_input(Option<TransformInput>)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::set_transform_input):<br>required: **true**<br><p>Describes the input source and the way the transform job consumes it.</p><br>
    ///   - [`transform_output(TransformOutput)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::transform_output) / [`set_transform_output(Option<TransformOutput>)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::set_transform_output):<br>required: **true**<br><p>Describes the results of the transform job.</p><br>
    ///   - [`data_capture_config(BatchDataCaptureConfig)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::data_capture_config) / [`set_data_capture_config(Option<BatchDataCaptureConfig>)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::set_data_capture_config):<br>required: **false**<br><p>Configuration to control how SageMaker captures inference data.</p><br>
    ///   - [`transform_resources(TransformResources)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::transform_resources) / [`set_transform_resources(Option<TransformResources>)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::set_transform_resources):<br>required: **true**<br><p>Describes the resources, including ML instance types and ML instance count, to use for the transform job.</p><br>
    ///   - [`data_processing(DataProcessing)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::data_processing) / [`set_data_processing(Option<DataProcessing>)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::set_data_processing):<br>required: **false**<br><p>The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html">Associate Prediction Results with their Corresponding Input Records</a>.</p><br>
    ///   - [`tags(Tag)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::set_tags):<br>required: **false**<br><p>(Optional) An array of key-value pairs. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what">Using Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User Guide</i>.</p><br>
    ///   - [`experiment_config(ExperimentConfig)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::experiment_config) / [`set_experiment_config(Option<ExperimentConfig>)`](crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::set_experiment_config):<br>required: **false**<br><p>Associates a SageMaker job as a trial component with an experiment and trial. Specified when you call the following APIs:</p> <ul>  <li>   <p><a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html">CreateProcessingJob</a></p></li>  <li>   <p><a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html">CreateTrainingJob</a></p></li>  <li>   <p><a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html">CreateTransformJob</a></p></li> </ul><br>
    /// - On success, responds with [`CreateTransformJobOutput`](crate::operation::create_transform_job::CreateTransformJobOutput) with field(s):
    ///   - [`transform_job_arn(Option<String>)`](crate::operation::create_transform_job::CreateTransformJobOutput::transform_job_arn): <p>The Amazon Resource Name (ARN) of the transform job.</p>
    /// - On failure, responds with [`SdkError<CreateTransformJobError>`](crate::operation::create_transform_job::CreateTransformJobError)
    pub fn create_transform_job(&self) -> crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder {
        crate::operation::create_transform_job::builders::CreateTransformJobFluentBuilder::new(self.handle.clone())
    }
}