aws_sdk_sagemaker/client/create_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 [`CreateJob`](crate::operation::create_job::builders::CreateJobFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`job_name(impl Into<String>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::job_name) / [`set_job_name(Option<String>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::set_job_name):<br>required: **true**<br><p>The name of the job. The name must be unique within your account and Amazon Web Services Region.</p><br>
7 /// - [`role_arn(impl Into<String>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::role_arn) / [`set_role_arn(Option<String>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::set_role_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the job. The role must have the necessary permissions to access the resources required by the job configuration.</p><br>
8 /// - [`job_category(JobCategory)`](crate::operation::create_job::builders::CreateJobFluentBuilder::job_category) / [`set_job_category(Option<JobCategory>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::set_job_category):<br>required: **true**<br><p>The category of the job. The category determines the type of workload that the job runs.</p><br>
9 /// - [`job_config_schema_version(impl Into<String>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::job_config_schema_version) / [`set_job_config_schema_version(Option<String>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::set_job_config_schema_version):<br>required: **true**<br><p>The version of the configuration schema to use for the job configuration document. Use <code>ListJobSchemaVersions</code> to get available schema versions for a job category.</p><br>
10 /// - [`job_config_document(impl Into<String>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::job_config_document) / [`set_job_config_document(Option<String>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::set_job_config_document):<br>required: **true**<br><p>The JSON configuration document for the job. The document must conform to the schema specified by <code>JobConfigSchemaVersion</code>. Use <code>DescribeJobSchemaVersion</code> to retrieve the schema for validation.</p><br>
11 /// - [`tags(Tag)`](crate::operation::create_job::builders::CreateJobFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::set_tags):<br>required: **false**<br><p>An array of key-value pairs to apply to the job as tags. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p><br>
12 /// - On success, responds with [`CreateJobOutput`](crate::operation::create_job::CreateJobOutput) with field(s):
13 /// - [`job_arn(Option<String>)`](crate::operation::create_job::CreateJobOutput::job_arn): <p>The Amazon Resource Name (ARN) of the job.</p>
14 /// - On failure, responds with [`SdkError<CreateJobError>`](crate::operation::create_job::CreateJobError)
15 pub fn create_job(&self) -> crate::operation::create_job::builders::CreateJobFluentBuilder {
16 crate::operation::create_job::builders::CreateJobFluentBuilder::new(self.handle.clone())
17 }
18}