aws_sdk_sagemaker/client/describe_processing_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 [`DescribeProcessingJob`](crate::operation::describe_processing_job::builders::DescribeProcessingJobFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`processing_job_name(impl Into<String>)`](crate::operation::describe_processing_job::builders::DescribeProcessingJobFluentBuilder::processing_job_name) / [`set_processing_job_name(Option<String>)`](crate::operation::describe_processing_job::builders::DescribeProcessingJobFluentBuilder::set_processing_job_name):<br>required: **true**<br><p>The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</p><br>
7 /// - On success, responds with [`DescribeProcessingJobOutput`](crate::operation::describe_processing_job::DescribeProcessingJobOutput) with field(s):
8 /// - [`processing_inputs(Option<Vec::<ProcessingInput>>)`](crate::operation::describe_processing_job::DescribeProcessingJobOutput::processing_inputs): <p>The inputs for a processing job.</p>
9 /// - [`processing_output_config(Option<ProcessingOutputConfig>)`](crate::operation::describe_processing_job::DescribeProcessingJobOutput::processing_output_config): <p>Output configuration for the processing job.</p>
10 /// - [`processing_job_name(Option<String>)`](crate::operation::describe_processing_job::DescribeProcessingJobOutput::processing_job_name): <p>The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.</p>
11 /// - [`processing_resources(Option<ProcessingResources>)`](crate::operation::describe_processing_job::DescribeProcessingJobOutput::processing_resources): <p>Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.</p>
12 /// - [`stopping_condition(Option<ProcessingStoppingCondition>)`](crate::operation::describe_processing_job::DescribeProcessingJobOutput::stopping_condition): <p>The time limit for how long the processing job is allowed to run.</p>
13 /// - [`app_specification(Option<AppSpecification>)`](crate::operation::describe_processing_job::DescribeProcessingJobOutput::app_specification): <p>Configures the processing job to run a specified container image.</p>
14 /// - [`environment(Option<HashMap::<String, String>>)`](crate::operation::describe_processing_job::DescribeProcessingJobOutput::environment): <p>The environment variables set in the Docker container.</p>
15 /// - [`network_config(Option<NetworkConfig>)`](crate::operation::describe_processing_job::DescribeProcessingJobOutput::network_config): <p>Networking options for a processing job.</p>
16 /// - [`role_arn(Option<String>)`](crate::operation::describe_processing_job::DescribeProcessingJobOutput::role_arn): <p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.</p>
17 /// - [`experiment_config(Option<ExperimentConfig>)`](crate::operation::describe_processing_job::DescribeProcessingJobOutput::experiment_config): <p>The configuration information used to create an experiment.</p>
18 /// - [`processing_job_arn(Option<String>)`](crate::operation::describe_processing_job::DescribeProcessingJobOutput::processing_job_arn): <p>The Amazon Resource Name (ARN) of the processing job.</p>
19 /// - [`processing_job_status(Option<ProcessingJobStatus>)`](crate::operation::describe_processing_job::DescribeProcessingJobOutput::processing_job_status): <p>Provides the status of a processing job.</p>
20 /// - [`exit_message(Option<String>)`](crate::operation::describe_processing_job::DescribeProcessingJobOutput::exit_message): <p>An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.</p>
21 /// - [`failure_reason(Option<String>)`](crate::operation::describe_processing_job::DescribeProcessingJobOutput::failure_reason): <p>A string, up to one KB in size, that contains the reason a processing job failed, if it failed.</p>
22 /// - [`processing_end_time(Option<DateTime>)`](crate::operation::describe_processing_job::DescribeProcessingJobOutput::processing_end_time): <p>The time at which the processing job completed.</p>
23 /// - [`processing_start_time(Option<DateTime>)`](crate::operation::describe_processing_job::DescribeProcessingJobOutput::processing_start_time): <p>The time at which the processing job started.</p>
24 /// - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_processing_job::DescribeProcessingJobOutput::last_modified_time): <p>The time at which the processing job was last modified.</p>
25 /// - [`creation_time(Option<DateTime>)`](crate::operation::describe_processing_job::DescribeProcessingJobOutput::creation_time): <p>The time at which the processing job was created.</p>
26 /// - [`monitoring_schedule_arn(Option<String>)`](crate::operation::describe_processing_job::DescribeProcessingJobOutput::monitoring_schedule_arn): <p>The ARN of a monitoring schedule for an endpoint associated with this processing job.</p>
27 /// - [`auto_ml_job_arn(Option<String>)`](crate::operation::describe_processing_job::DescribeProcessingJobOutput::auto_ml_job_arn): <p>The ARN of an AutoML job associated with this processing job.</p>
28 /// - [`training_job_arn(Option<String>)`](crate::operation::describe_processing_job::DescribeProcessingJobOutput::training_job_arn): <p>The ARN of a training job associated with this processing job.</p>
29 /// - On failure, responds with [`SdkError<DescribeProcessingJobError>`](crate::operation::describe_processing_job::DescribeProcessingJobError)
30 pub fn describe_processing_job(&self) -> crate::operation::describe_processing_job::builders::DescribeProcessingJobFluentBuilder {
31 crate::operation::describe_processing_job::builders::DescribeProcessingJobFluentBuilder::new(self.handle.clone())
32 }
33}