aws_sdk_iot/client/describe_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 [`DescribeJob`](crate::operation::describe_job::builders::DescribeJobFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`job_id(impl Into<String>)`](crate::operation::describe_job::builders::DescribeJobFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::describe_job::builders::DescribeJobFluentBuilder::set_job_id):<br>required: **true**<br><p>The unique identifier you assigned to this job when it was created.</p><br>
7 /// - [`before_substitution(bool)`](crate::operation::describe_job::builders::DescribeJobFluentBuilder::before_substitution) / [`set_before_substitution(Option<bool>)`](crate::operation::describe_job::builders::DescribeJobFluentBuilder::set_before_substitution):<br>required: **false**<br><p>Provides a view of the job document before and after the substitution parameters have been resolved with their exact values.</p><br>
8 /// - On success, responds with [`DescribeJobOutput`](crate::operation::describe_job::DescribeJobOutput) with field(s):
9 /// - [`document_source(Option<String>)`](crate::operation::describe_job::DescribeJobOutput::document_source): <p>An S3 link to the job document.</p>
10 /// - [`job(Option<Job>)`](crate::operation::describe_job::DescribeJobOutput::job): <p>Information about the job.</p>
11 /// - On failure, responds with [`SdkError<DescribeJobError>`](crate::operation::describe_job::DescribeJobError)
12 pub fn describe_job(&self) -> crate::operation::describe_job::builders::DescribeJobFluentBuilder {
13 crate::operation::describe_job::builders::DescribeJobFluentBuilder::new(self.handle.clone())
14 }
15}