aws_sdk_s3control/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    ///   - [`account_id(impl Into<String>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::account_id) / [`set_account_id(Option<String>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::set_account_id):<br>required: **true**<br><p>The Amazon Web Services account ID that creates the job.</p><br>
7    ///   - [`confirmation_required(bool)`](crate::operation::create_job::builders::CreateJobFluentBuilder::confirmation_required) / [`set_confirmation_required(Option<bool>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::set_confirmation_required):<br>required: **false**<br><p>Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.</p><br>
8    ///   - [`operation(JobOperation)`](crate::operation::create_job::builders::CreateJobFluentBuilder::operation) / [`set_operation(Option<JobOperation>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::set_operation):<br>required: **true**<br><p>The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html">Operations</a> in the <i>Amazon S3 User Guide</i>.</p><br>
9    ///   - [`report(JobReport)`](crate::operation::create_job::builders::CreateJobFluentBuilder::report) / [`set_report(Option<JobReport>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::set_report):<br>required: **true**<br><p>Configuration parameters for the optional job-completion report.</p><br>
10    ///   - [`client_request_token(impl Into<String>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::client_request_token) / [`set_client_request_token(Option<String>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::set_client_request_token):<br>required: **true**<br><p>An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.</p><br>
11    ///   - [`manifest(JobManifest)`](crate::operation::create_job::builders::CreateJobFluentBuilder::manifest) / [`set_manifest(Option<JobManifest>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::set_manifest):<br>required: **false**<br><p>Configuration parameters for the manifest.</p><br>
12    ///   - [`description(impl Into<String>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::set_description):<br>required: **false**<br><p>A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.</p><br>
13    ///   - [`priority(i32)`](crate::operation::create_job::builders::CreateJobFluentBuilder::priority) / [`set_priority(Option<i32>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::set_priority):<br>required: **true**<br><p>The numerical priority for this job. Higher numbers indicate higher priority.</p><br>
14    ///   - [`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) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.</p><br>
15    ///   - [`tags(S3Tag)`](crate::operation::create_job::builders::CreateJobFluentBuilder::tags) / [`set_tags(Option<Vec::<S3Tag>>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::set_tags):<br>required: **false**<br><p>A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.</p><br>
16    ///   - [`manifest_generator(JobManifestGenerator)`](crate::operation::create_job::builders::CreateJobFluentBuilder::manifest_generator) / [`set_manifest_generator(Option<JobManifestGenerator>)`](crate::operation::create_job::builders::CreateJobFluentBuilder::set_manifest_generator):<br>required: **false**<br><p>The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.</p><br>
17    /// - On success, responds with [`CreateJobOutput`](crate::operation::create_job::CreateJobOutput) with field(s):
18    ///   - [`job_id(Option<String>)`](crate::operation::create_job::CreateJobOutput::job_id): <p>The ID for this job. Amazon S3 generates this ID automatically and returns it after a successful <code>Create Job</code> request.</p>
19    /// - On failure, responds with [`SdkError<CreateJobError>`](crate::operation::create_job::CreateJobError)
20    pub fn create_job(&self) -> crate::operation::create_job::builders::CreateJobFluentBuilder {
21        crate::operation::create_job::builders::CreateJobFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_s3control/client/create_job.rs

aws_sdk_s3control/client/
create_job.rs
