aws_sdk_sagemaker/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_name(impl Into<String>)`](crate::operation::describe_job::builders::DescribeJobFluentBuilder::job_name) / [`set_job_name(Option<String>)`](crate::operation::describe_job::builders::DescribeJobFluentBuilder::set_job_name):<br>required: **true**<br><p>The name of the job to describe.</p><br>
7    ///   - [`job_category(JobCategory)`](crate::operation::describe_job::builders::DescribeJobFluentBuilder::job_category) / [`set_job_category(Option<JobCategory>)`](crate::operation::describe_job::builders::DescribeJobFluentBuilder::set_job_category):<br>required: **true**<br><p>The category of the job.</p><br>
8    /// - On success, responds with [`DescribeJobOutput`](crate::operation::describe_job::DescribeJobOutput) with field(s):
9    ///   - [`job_name(Option<String>)`](crate::operation::describe_job::DescribeJobOutput::job_name): <p>The name of the job.</p>
10    ///   - [`job_arn(Option<String>)`](crate::operation::describe_job::DescribeJobOutput::job_arn): <p>The Amazon Resource Name (ARN) of the job.</p>
11    ///   - [`role_arn(Option<String>)`](crate::operation::describe_job::DescribeJobOutput::role_arn): <p>The ARN of the IAM role associated with the job.</p>
12    ///   - [`job_category(Option<JobCategory>)`](crate::operation::describe_job::DescribeJobOutput::job_category): <p>The category of the job.</p>
13    ///   - [`job_config_schema_version(Option<String>)`](crate::operation::describe_job::DescribeJobOutput::job_config_schema_version): <p>The schema version used for the job configuration document.</p>
14    ///   - [`job_config_document(Option<String>)`](crate::operation::describe_job::DescribeJobOutput::job_config_document): <p>The JSON configuration document for the job.</p>
15    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_job::DescribeJobOutput::creation_time): <p>The date and time that the job was created.</p>
16    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_job::DescribeJobOutput::last_modified_time): <p>The date and time that the job was last modified.</p>
17    ///   - [`end_time(Option<DateTime>)`](crate::operation::describe_job::DescribeJobOutput::end_time): <p>The date and time that the job ended.</p>
18    ///   - [`job_status(Option<JobStatus>)`](crate::operation::describe_job::DescribeJobOutput::job_status): <p>The current status of the job.</p>
19    ///   - [`secondary_status(Option<JobSecondaryStatus>)`](crate::operation::describe_job::DescribeJobOutput::secondary_status): <p>The detailed secondary status of the job, providing more granular information about the job's progress. Secondary statuses may change between releases.</p>
20    ///   - [`secondary_status_transitions(Option<Vec::<JobSecondaryStatusTransition>>)`](crate::operation::describe_job::DescribeJobOutput::secondary_status_transitions): <p>A list of secondary status transitions for the job, with timestamps and optional status messages.</p>
21    ///   - [`failure_reason(Option<String>)`](crate::operation::describe_job::DescribeJobOutput::failure_reason): <p>If the job failed, the reason it failed.</p>
22    ///   - [`tags(Option<Vec::<Tag>>)`](crate::operation::describe_job::DescribeJobOutput::tags): <p>The tags associated with the job.</p>
23    /// - On failure, responds with [`SdkError<DescribeJobError>`](crate::operation::describe_job::DescribeJobError)
24    pub fn describe_job(&self) -> crate::operation::describe_job::builders::DescribeJobFluentBuilder {
25        crate::operation::describe_job::builders::DescribeJobFluentBuilder::new(self.handle.clone())
26    }
27}
aws_sdk_sagemaker/client/describe_job.rs

aws_sdk_sagemaker/client/
describe_job.rs
