aws_sdk_sagemaker/client/
create_processing_job.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateProcessingJob`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`processing_inputs(ProcessingInput)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::processing_inputs) / [`set_processing_inputs(Option<Vec::<ProcessingInput>>)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::set_processing_inputs):<br>required: **false**<br><p>An array of inputs configuring the data to download into the processing container.</p><br>
7    ///   - [`processing_output_config(ProcessingOutputConfig)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::processing_output_config) / [`set_processing_output_config(Option<ProcessingOutputConfig>)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::set_processing_output_config):<br>required: **false**<br><p>Output configuration for the processing job.</p><br>
8    ///   - [`processing_job_name(impl Into<String>)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::processing_job_name) / [`set_processing_job_name(Option<String>)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::set_processing_job_name):<br>required: **true**<br><p>The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</p><br>
9    ///   - [`processing_resources(ProcessingResources)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::processing_resources) / [`set_processing_resources(Option<ProcessingResources>)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::set_processing_resources):<br>required: **true**<br><p>Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.</p><br>
10    ///   - [`stopping_condition(ProcessingStoppingCondition)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::stopping_condition) / [`set_stopping_condition(Option<ProcessingStoppingCondition>)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::set_stopping_condition):<br>required: **false**<br><p>The time limit for how long the processing job is allowed to run.</p><br>
11    ///   - [`app_specification(AppSpecification)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::app_specification) / [`set_app_specification(Option<AppSpecification>)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::set_app_specification):<br>required: **true**<br><p>Configures the processing job to run a specified Docker container image.</p><br>
12    ///   - [`environment(impl Into<String>, impl Into<String>)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::environment) / [`set_environment(Option<HashMap::<String, String>>)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::set_environment):<br>required: **false**<br><p>The environment variables to set in the Docker container. Up to 100 key and values entries in the map are supported.</p><important>  <p>Do not include any security-sensitive information including account access IDs, secrets, or tokens in any environment fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request environment variable or plain text fields.</p> </important><br>
13    ///   - [`network_config(NetworkConfig)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::network_config) / [`set_network_config(Option<NetworkConfig>)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::set_network_config):<br>required: **false**<br><p>Networking options for a processing job, such as whether to allow inbound and outbound network calls to and from processing containers, and the VPC subnets and security groups to use for VPC-enabled processing jobs.</p><br>
14    ///   - [`role_arn(impl Into<String>)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::set_role_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.</p><br>
15    ///   - [`tags(Tag)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::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-whatURL">Using Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User Guide</i>.</p><important>  <p>Do not include any security-sensitive information including account access IDs, secrets, or tokens in any tags. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request tag variable or plain text fields.</p> </important><br>
16    ///   - [`experiment_config(ExperimentConfig)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::experiment_config) / [`set_experiment_config(Option<ExperimentConfig>)`](crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::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>
17    /// - On success, responds with [`CreateProcessingJobOutput`](crate::operation::create_processing_job::CreateProcessingJobOutput) with field(s):
18    ///   - [`processing_job_arn(Option<String>)`](crate::operation::create_processing_job::CreateProcessingJobOutput::processing_job_arn): <p>The Amazon Resource Name (ARN) of the processing job.</p>
19    /// - On failure, responds with [`SdkError<CreateProcessingJobError>`](crate::operation::create_processing_job::CreateProcessingJobError)
20    pub fn create_processing_job(&self) -> crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder {
21        crate::operation::create_processing_job::builders::CreateProcessingJobFluentBuilder::new(self.handle.clone())
22    }
23}