aws_sdk_batch/client/
describe_service_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 [`DescribeServiceJob`](crate::operation::describe_service_job::builders::DescribeServiceJobFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`job_id(impl Into<String>)`](crate::operation::describe_service_job::builders::DescribeServiceJobFluentBuilder::job_id) / [`set_job_id(Option<String>)`](crate::operation::describe_service_job::builders::DescribeServiceJobFluentBuilder::set_job_id):<br>required: **true**<br><p>The job ID for the service job to describe.</p><br>
7    /// - On success, responds with [`DescribeServiceJobOutput`](crate::operation::describe_service_job::DescribeServiceJobOutput) with field(s):
8    ///   - [`attempts(Option<Vec::<ServiceJobAttemptDetail>>)`](crate::operation::describe_service_job::DescribeServiceJobOutput::attempts): <p>A list of job attempts associated with the service job.</p>
9    ///   - [`created_at(Option<i64>)`](crate::operation::describe_service_job::DescribeServiceJobOutput::created_at): <p>The Unix timestamp (in milliseconds) for when the service job was created.</p>
10    ///   - [`is_terminated(Option<bool>)`](crate::operation::describe_service_job::DescribeServiceJobOutput::is_terminated): <p>Indicates whether the service job has been terminated.</p>
11    ///   - [`job_arn(Option<String>)`](crate::operation::describe_service_job::DescribeServiceJobOutput::job_arn): <p>The Amazon Resource Name (ARN) of the service job.</p>
12    ///   - [`job_id(Option<String>)`](crate::operation::describe_service_job::DescribeServiceJobOutput::job_id): <p>The job ID for the service job.</p>
13    ///   - [`job_name(Option<String>)`](crate::operation::describe_service_job::DescribeServiceJobOutput::job_name): <p>The name of the service job.</p>
14    ///   - [`job_queue(Option<String>)`](crate::operation::describe_service_job::DescribeServiceJobOutput::job_queue): <p>The ARN of the job queue that the service job is associated with.</p>
15    ///   - [`latest_attempt(Option<LatestServiceJobAttempt>)`](crate::operation::describe_service_job::DescribeServiceJobOutput::latest_attempt): <p>The latest attempt associated with the service job.</p>
16    ///   - [`retry_strategy(Option<ServiceJobRetryStrategy>)`](crate::operation::describe_service_job::DescribeServiceJobOutput::retry_strategy): <p>The retry strategy to use for failed service jobs that are submitted with this service job.</p>
17    ///   - [`scheduling_priority(Option<i32>)`](crate::operation::describe_service_job::DescribeServiceJobOutput::scheduling_priority): <p>The scheduling priority of the service job.</p>
18    ///   - [`service_request_payload(Option<String>)`](crate::operation::describe_service_job::DescribeServiceJobOutput::service_request_payload): <p>The request, in JSON, for the service that the <code>SubmitServiceJob</code> operation is queueing.</p>
19    ///   - [`service_job_type(Option<ServiceJobType>)`](crate::operation::describe_service_job::DescribeServiceJobOutput::service_job_type): <p>The type of service job. For SageMaker Training jobs, this value is <code>SAGEMAKER_TRAINING</code>.</p>
20    ///   - [`share_identifier(Option<String>)`](crate::operation::describe_service_job::DescribeServiceJobOutput::share_identifier): <p>The share identifier for the service job. This is used for fair-share scheduling.</p>
21    ///   - [`started_at(Option<i64>)`](crate::operation::describe_service_job::DescribeServiceJobOutput::started_at): <p>The Unix timestamp (in milliseconds) for when the service job was started.</p>
22    ///   - [`status(Option<ServiceJobStatus>)`](crate::operation::describe_service_job::DescribeServiceJobOutput::status): <p>The current status of the service job.</p>
23    ///   - [`status_reason(Option<String>)`](crate::operation::describe_service_job::DescribeServiceJobOutput::status_reason): <p>A short, human-readable string to provide more details for the current status of the service job.</p>
24    ///   - [`stopped_at(Option<i64>)`](crate::operation::describe_service_job::DescribeServiceJobOutput::stopped_at): <p>The Unix timestamp (in milliseconds) for when the service job stopped running.</p>
25    ///   - [`tags(Option<HashMap::<String, String>>)`](crate::operation::describe_service_job::DescribeServiceJobOutput::tags): <p>The tags that are associated with the service job. Each tag consists of a key and an optional value. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html">Tagging your Batch resources</a>.</p>
26    ///   - [`timeout_config(Option<ServiceJobTimeout>)`](crate::operation::describe_service_job::DescribeServiceJobOutput::timeout_config): <p>The timeout configuration for the service job.</p>
27    /// - On failure, responds with [`SdkError<DescribeServiceJobError>`](crate::operation::describe_service_job::DescribeServiceJobError)
28    pub fn describe_service_job(&self) -> crate::operation::describe_service_job::builders::DescribeServiceJobFluentBuilder {
29        crate::operation::describe_service_job::builders::DescribeServiceJobFluentBuilder::new(self.handle.clone())
30    }
31}