aws_sdk_iotjobsdataplane/client/
describe_job_execution.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 [`DescribeJobExecution`](crate::operation::describe_job_execution::builders::DescribeJobExecutionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`job_id(impl Into<String>)`](crate::operation::describe_job_execution::builders::DescribeJobExecutionFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::describe_job_execution::builders::DescribeJobExecutionFluentBuilder::set_job_id):<br>required: **true**<br><p>The unique identifier assigned to this job when it was created.</p><br>
7    ///   - [`thing_name(impl Into<String>)`](crate::operation::describe_job_execution::builders::DescribeJobExecutionFluentBuilder::thing_name) / [`set_thing_name(Option<String>)`](crate::operation::describe_job_execution::builders::DescribeJobExecutionFluentBuilder::set_thing_name):<br>required: **true**<br><p>The thing name associated with the device the job execution is running on.</p><br>
8    ///   - [`include_job_document(bool)`](crate::operation::describe_job_execution::builders::DescribeJobExecutionFluentBuilder::include_job_document) / [`set_include_job_document(Option<bool>)`](crate::operation::describe_job_execution::builders::DescribeJobExecutionFluentBuilder::set_include_job_document):<br>required: **false**<br><p>Optional. Unless set to false, the response contains the job document. The default is true.</p><br>
9    ///   - [`execution_number(i64)`](crate::operation::describe_job_execution::builders::DescribeJobExecutionFluentBuilder::execution_number) / [`set_execution_number(Option<i64>)`](crate::operation::describe_job_execution::builders::DescribeJobExecutionFluentBuilder::set_execution_number):<br>required: **false**<br><p>Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.</p><br>
10    /// - On success, responds with [`DescribeJobExecutionOutput`](crate::operation::describe_job_execution::DescribeJobExecutionOutput) with field(s):
11    ///   - [`execution(Option<JobExecution>)`](crate::operation::describe_job_execution::DescribeJobExecutionOutput::execution): <p>Contains data about a job execution.</p>
12    /// - On failure, responds with [`SdkError<DescribeJobExecutionError>`](crate::operation::describe_job_execution::DescribeJobExecutionError)
13    pub fn describe_job_execution(&self) -> crate::operation::describe_job_execution::builders::DescribeJobExecutionFluentBuilder {
14        crate::operation::describe_job_execution::builders::DescribeJobExecutionFluentBuilder::new(self.handle.clone())
15    }
16}
aws_sdk_iotjobsdataplane/client/describe_job_execution.rs

aws_sdk_iotjobsdataplane/client/
describe_job_execution.rs
