Struct aws_sdk_s3control::input::create_job_input::Builder

pub struct Builder { /* private fields */ }

A builder for CreateJobInput.

Implementations

impl Builder

pub fn account_id(self, input: impl Into<String>) -> Self

The Amazon Web Services account ID that creates the job.

Examples found in repository

src/client.rs (line 1452)

        pub fn account_id(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.account_id(input.into());
            self
        }

pub fn set_account_id(self, input: Option<String>) -> Self

The Amazon Web Services account ID that creates the job.

Examples found in repository

src/client.rs (line 1457)

        pub fn set_account_id(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_account_id(input);
            self
        }

pub fn confirmation_required(self, input: bool) -> Self

Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

Examples found in repository

src/client.rs (line 1462)

        pub fn confirmation_required(mut self, input: bool) -> Self {
            self.inner = self.inner.confirmation_required(input);
            self
        }

pub fn set_confirmation_required(self, input: Option<bool>) -> Self

Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

Examples found in repository

src/client.rs (line 1467)

        pub fn set_confirmation_required(mut self, input: std::option::Option<bool>) -> Self {
            self.inner = self.inner.set_confirmation_required(input);
            self
        }

pub fn operation(self, input: JobOperation) -> Self

The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User Guide.

Examples found in repository

src/client.rs (line 1472)

        pub fn operation(mut self, input: crate::model::JobOperation) -> Self {
            self.inner = self.inner.operation(input);
            self
        }

pub fn set_operation(self, input: Option<JobOperation>) -> Self

The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User Guide.

Examples found in repository

src/client.rs (line 1480)

        pub fn set_operation(
            mut self,
            input: std::option::Option<crate::model::JobOperation>,
        ) -> Self {
            self.inner = self.inner.set_operation(input);
            self
        }

pub fn report(self, input: JobReport) -> Self

Configuration parameters for the optional job-completion report.

Examples found in repository

src/client.rs (line 1485)

        pub fn report(mut self, input: crate::model::JobReport) -> Self {
            self.inner = self.inner.report(input);
            self
        }

pub fn set_report(self, input: Option<JobReport>) -> Self

Configuration parameters for the optional job-completion report.

Examples found in repository

src/client.rs (line 1490)

        pub fn set_report(mut self, input: std::option::Option<crate::model::JobReport>) -> Self {
            self.inner = self.inner.set_report(input);
            self
        }

pub fn client_request_token(self, input: impl Into<String>) -> Self

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.

Examples found in repository

src/client.rs (line 1495)

        pub fn client_request_token(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.client_request_token(input.into());
            self
        }

pub fn set_client_request_token(self, input: Option<String>) -> Self

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.

Examples found in repository

src/client.rs (line 1503)

        pub fn set_client_request_token(
            mut self,
            input: std::option::Option<std::string::String>,
        ) -> Self {
            self.inner = self.inner.set_client_request_token(input);
            self
        }

pub fn manifest(self, input: JobManifest) -> Self

Configuration parameters for the manifest.

Examples found in repository

src/client.rs (line 1508)

        pub fn manifest(mut self, input: crate::model::JobManifest) -> Self {
            self.inner = self.inner.manifest(input);
            self
        }

pub fn set_manifest(self, input: Option<JobManifest>) -> Self

Configuration parameters for the manifest.

Examples found in repository

src/client.rs (line 1516)

        pub fn set_manifest(
            mut self,
            input: std::option::Option<crate::model::JobManifest>,
        ) -> Self {
            self.inner = self.inner.set_manifest(input);
            self
        }

pub fn description(self, input: impl Into<String>) -> Self

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.

Examples found in repository

src/client.rs (line 1521)

        pub fn description(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.description(input.into());
            self
        }

pub fn set_description(self, input: Option<String>) -> Self

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.

Examples found in repository

src/client.rs (line 1526)

        pub fn set_description(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_description(input);
            self
        }

pub fn priority(self, input: i32) -> Self

The numerical priority for this job. Higher numbers indicate higher priority.

Examples found in repository

src/client.rs (line 1531)

        pub fn priority(mut self, input: i32) -> Self {
            self.inner = self.inner.priority(input);
            self
        }

pub fn set_priority(self, input: Option<i32>) -> Self

The numerical priority for this job. Higher numbers indicate higher priority.

Examples found in repository

src/client.rs (line 1536)

        pub fn set_priority(mut self, input: std::option::Option<i32>) -> Self {
            self.inner = self.inner.set_priority(input);
            self
        }

pub fn role_arn(self, input: impl Into<String>) -> Self

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.

Examples found in repository

src/client.rs (line 1541)

        pub fn role_arn(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.role_arn(input.into());
            self
        }

pub fn set_role_arn(self, input: Option<String>) -> Self

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.

Examples found in repository

src/client.rs (line 1546)

        pub fn set_role_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_role_arn(input);
            self
        }

pub fn tags(self, input: S3Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

Examples found in repository

src/client.rs (line 1555)

        pub fn tags(mut self, input: crate::model::S3Tag) -> Self {
            self.inner = self.inner.tags(input);
            self
        }

pub fn set_tags(self, input: Option<Vec<S3Tag>>) -> Self

A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.

Examples found in repository

src/client.rs (line 1563)

        pub fn set_tags(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::S3Tag>>,
        ) -> Self {
            self.inner = self.inner.set_tags(input);
            self
        }

pub fn manifest_generator(self, input: JobManifestGenerator) -> Self

The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.

Examples found in repository

src/client.rs (line 1568)

        pub fn manifest_generator(mut self, input: crate::model::JobManifestGenerator) -> Self {
            self.inner = self.inner.manifest_generator(input);
            self
        }

pub fn set_manifest_generator(self, input: Option<JobManifestGenerator>) -> Self

The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.

Examples found in repository

src/client.rs (line 1576)

        pub fn set_manifest_generator(
            mut self,
            input: std::option::Option<crate::model::JobManifestGenerator>,
        ) -> Self {
            self.inner = self.inner.set_manifest_generator(input);
            self
        }

pub fn build(self) -> Result<CreateJobInput, BuildError>

Consumes the builder and constructs a CreateJobInput.

Examples found in repository

src/client.rs (line 1419)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::CreateJob,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::CreateJobError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// Sends the request and returns the response.
        ///
        /// If an error occurs, an `SdkError` will be returned with additional details that
        /// can be matched against.
        ///
        /// By default, any retryable failures will be retried twice. Retry behavior
        /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::CreateJobOutput,
            aws_smithy_http::result::SdkError<crate::error::CreateJobError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Builder