aws_sdk_m2/client/
start_batch_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 [`StartBatchJob`](crate::operation::start_batch_job::builders::StartBatchJobFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`application_id(impl Into<String>)`](crate::operation::start_batch_job::builders::StartBatchJobFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::start_batch_job::builders::StartBatchJobFluentBuilder::set_application_id):<br>required: **true**<br><p>The unique identifier of the application associated with this batch job.</p><br>
7    ///   - [`batch_job_identifier(BatchJobIdentifier)`](crate::operation::start_batch_job::builders::StartBatchJobFluentBuilder::batch_job_identifier) / [`set_batch_job_identifier(Option<BatchJobIdentifier>)`](crate::operation::start_batch_job::builders::StartBatchJobFluentBuilder::set_batch_job_identifier):<br>required: **true**<br><p>The unique identifier of the batch job.</p><br>
8    ///   - [`job_params(impl Into<String>, impl Into<String>)`](crate::operation::start_batch_job::builders::StartBatchJobFluentBuilder::job_params) / [`set_job_params(Option<HashMap::<String, String>>)`](crate::operation::start_batch_job::builders::StartBatchJobFluentBuilder::set_job_params):<br>required: **false**<br><p>The collection of batch job parameters. For details about limits for keys and values, see <a href="https://www.ibm.com/docs/en/workload-automation/9.3.0?topic=zos-coding-variables-in-jcl">Coding variables in JCL</a>.</p><br>
9    ///   - [`auth_secrets_manager_arn(impl Into<String>)`](crate::operation::start_batch_job::builders::StartBatchJobFluentBuilder::auth_secrets_manager_arn) / [`set_auth_secrets_manager_arn(Option<String>)`](crate::operation::start_batch_job::builders::StartBatchJobFluentBuilder::set_auth_secrets_manager_arn):<br>required: **false**<br><p>The Amazon Web Services Secrets Manager containing user's credentials for authentication and authorization for Start Batch Job execution operation.</p><br>
10    /// - On success, responds with [`StartBatchJobOutput`](crate::operation::start_batch_job::StartBatchJobOutput) with field(s):
11    ///   - [`execution_id(String)`](crate::operation::start_batch_job::StartBatchJobOutput::execution_id): <p>The unique identifier of this execution of the batch job.</p>
12    /// - On failure, responds with [`SdkError<StartBatchJobError>`](crate::operation::start_batch_job::StartBatchJobError)
13    pub fn start_batch_job(&self) -> crate::operation::start_batch_job::builders::StartBatchJobFluentBuilder {
14        crate::operation::start_batch_job::builders::StartBatchJobFluentBuilder::new(self.handle.clone())
15    }
16}