aws_sdk_location/client/
get_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 [`GetJob`](crate::operation::get_job::builders::GetJobFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`job_id(impl Into<String>)`](crate::operation::get_job::builders::GetJobFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::get_job::builders::GetJobFluentBuilder::set_job_id):<br>required: **true**<br><p>The unique identifier of the job to retrieve.</p><br>
7    /// - On success, responds with [`GetJobOutput`](crate::operation::get_job::GetJobOutput) with field(s):
8    ///   - [`action(JobAction)`](crate::operation::get_job::GetJobOutput::action): <p>Action performed by the job.</p>
9    ///   - [`action_options(Option<JobActionOptions>)`](crate::operation::get_job::GetJobOutput::action_options): <p>Additional options for configuring job action parameters.</p>
10    ///   - [`created_at(DateTime)`](crate::operation::get_job::GetJobOutput::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>
11    ///   - [`ended_at(Option<DateTime>)`](crate::operation::get_job::GetJobOutput::ended_at): <p>Job completion 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>. Only returned for jobs in a terminal status: <code>Completed</code> | <code>Failed</code> | <code>Cancelled</code>.</p>
12    ///   - [`error(Option<JobError>)`](crate::operation::get_job::GetJobOutput::error): <p>Error information if the job failed.</p>
13    ///   - [`execution_role_arn(String)`](crate::operation::get_job::GetJobOutput::execution_role_arn): <p>IAM role used for permissions when running the job.</p>
14    ///   - [`input_options(Option<JobInputOptions>)`](crate::operation::get_job::GetJobOutput::input_options): <p>Input configuration.</p>
15    ///   - [`job_arn(String)`](crate::operation::get_job::GetJobOutput::job_arn): <p>Amazon Resource Name (ARN) of the specified job.</p>
16    ///   - [`job_id(String)`](crate::operation::get_job::GetJobOutput::job_id): <p>Unique job identifier.</p>
17    ///   - [`name(Option<String>)`](crate::operation::get_job::GetJobOutput::name): <p>Job name (if provided during creation).</p>
18    ///   - [`output_options(Option<JobOutputOptions>)`](crate::operation::get_job::GetJobOutput::output_options): <p>Output configuration.</p>
19    ///   - [`status(JobStatus)`](crate::operation::get_job::GetJobOutput::status): <p>Current job status.</p>
20    ///   - [`updated_at(DateTime)`](crate::operation::get_job::GetJobOutput::updated_at): <p>Last update 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>
21    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::get_job::GetJobOutput::tags): <p>Tags and corresponding values associated with the specified job.</p>
22    /// - On failure, responds with [`SdkError<GetJobError>`](crate::operation::get_job::GetJobError)
23    pub fn get_job(&self) -> crate::operation::get_job::builders::GetJobFluentBuilder {
24        crate::operation::get_job::builders::GetJobFluentBuilder::new(self.handle.clone())
25    }
26}
aws_sdk_location/client/get_job.rs

aws_sdk_location/client/
get_job.rs
