aws_sdk_location/client/
start_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 [`StartJob`](crate::operation::start_job::builders::StartJobFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`client_token(impl Into<String>)`](crate::operation::start_job::builders::StartJobFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_job::builders::StartJobFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique identifier for this request to ensure idempotency.</p><br>
7    ///   - [`action(JobAction)`](crate::operation::start_job::builders::StartJobFluentBuilder::action) / [`set_action(Option<JobAction>)`](crate::operation::start_job::builders::StartJobFluentBuilder::set_action):<br>required: **true**<br><p>The action to perform on the input data.</p><br>
8    ///   - [`action_options(JobActionOptions)`](crate::operation::start_job::builders::StartJobFluentBuilder::action_options) / [`set_action_options(Option<JobActionOptions>)`](crate::operation::start_job::builders::StartJobFluentBuilder::set_action_options):<br>required: **false**<br><p>Additional parameters that can be requested for each result.</p><br>
9    ///   - [`execution_role_arn(impl Into<String>)`](crate::operation::start_job::builders::StartJobFluentBuilder::execution_role_arn) / [`set_execution_role_arn(Option<String>)`](crate::operation::start_job::builders::StartJobFluentBuilder::set_execution_role_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the IAM role that Amazon Location Service assumes during job processing. Amazon Location Service uses this role to access the input and output locations specified for the job.</p><note>  <p>The IAM role must be created in the same Amazon Web Services account where you plan to run your job.</p> </note> <p>For more information about configuring IAM roles for Amazon Location jobs, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/configure-iam-role-policy-credentials.html">Configure IAM permissions</a> in the <i>Amazon Location Service Developer Guide</i>.</p><br>
10    ///   - [`input_options(JobInputOptions)`](crate::operation::start_job::builders::StartJobFluentBuilder::input_options) / [`set_input_options(Option<JobInputOptions>)`](crate::operation::start_job::builders::StartJobFluentBuilder::set_input_options):<br>required: **true**<br><p>Configuration for input data location and format.</p><note>  <p>Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.</p> </note><br>
11    ///   - [`name(impl Into<String>)`](crate::operation::start_job::builders::StartJobFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::start_job::builders::StartJobFluentBuilder::set_name):<br>required: **false**<br><p>An optional name for the job resource.</p><br>
12    ///   - [`output_options(JobOutputOptions)`](crate::operation::start_job::builders::StartJobFluentBuilder::output_options) / [`set_output_options(Option<JobOutputOptions>)`](crate::operation::start_job::builders::StartJobFluentBuilder::set_output_options):<br>required: **true**<br><p>Configuration for output data location and format.</p><br>
13    ///   - [`tags(impl Into<String>, impl Into<String>)`](crate::operation::start_job::builders::StartJobFluentBuilder::tags) / [`set_tags(Option<HashMap::<String, String>>)`](crate::operation::start_job::builders::StartJobFluentBuilder::set_tags):<br>required: **false**<br><p>Tags and corresponding values to be associated with the job.</p><br>
14    /// - On success, responds with [`StartJobOutput`](crate::operation::start_job::StartJobOutput) with field(s):
15    ///   - [`created_at(DateTime)`](crate::operation::start_job::StartJobOutput::created_at): <p>Job creation time in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sss</code>.</p>
16    ///   - [`job_arn(String)`](crate::operation::start_job::StartJobOutput::job_arn): <p>The Amazon Resource Name (ARN) for the job resource. Used when you need to specify a resource across all Amazon Web Services.</p> <p>Format example: <code>arn:aws:geo:region:account-id:job/ExampleJob</code></p>
17    ///   - [`job_id(String)`](crate::operation::start_job::StartJobOutput::job_id): <p>Unique job identifier.</p>
18    ///   - [`status(JobStatus)`](crate::operation::start_job::StartJobOutput::status): <p>Initial job status (always "Pending" for new jobs).</p>
19    /// - On failure, responds with [`SdkError<StartJobError>`](crate::operation::start_job::StartJobError)
20    pub fn start_job(&self) -> crate::operation::start_job::builders::StartJobFluentBuilder {
21        crate::operation::start_job::builders::StartJobFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_location/client/start_job.rs

aws_sdk_location/client/
start_job.rs
