aws_sdk_deadline/operation/
get_job.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `GetJob`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct GetJob;
6impl GetJob {
7    /// Creates a new `GetJob`
8    pub fn new() -> Self {
9        Self
10    }
11    pub(crate) async fn orchestrate(
12        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
13        input: crate::operation::get_job::GetJobInput,
14    ) -> ::std::result::Result<
15        crate::operation::get_job::GetJobOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::get_job::GetJobError,
18            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
19        >,
20    > {
21        let map_err =
22            |err: ::aws_smithy_runtime_api::client::result::SdkError<
23                ::aws_smithy_runtime_api::client::interceptors::context::Error,
24                ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
25            >| { err.map_service_error(|err| err.downcast::<crate::operation::get_job::GetJobError>().expect("correct error type")) };
26        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
27            .await
28            .map_err(map_err)?;
29        let output = context.finalize().map_err(map_err)?;
30        ::std::result::Result::Ok(output.downcast::<crate::operation::get_job::GetJobOutput>().expect("correct output type"))
31    }
32
33    pub(crate) async fn orchestrate_with_stop_point(
34        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
35        input: crate::operation::get_job::GetJobInput,
36        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
37    ) -> ::std::result::Result<
38        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
39        ::aws_smithy_runtime_api::client::result::SdkError<
40            ::aws_smithy_runtime_api::client::interceptors::context::Error,
41            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
42        >,
43    > {
44        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
45        use ::tracing::Instrument;
46        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("deadline", "GetJob", input, runtime_plugins, stop_point)
47            // Create a parent span for the entire operation. Includes a random, internal-only,
48            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
49            .instrument(::tracing::debug_span!(
50                "deadline.GetJob",
51                "rpc.service" = "deadline",
52                "rpc.method" = "GetJob",
53                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
54                "rpc.system" = "aws-api",
55            ))
56            .await
57    }
58
59    pub(crate) fn operation_runtime_plugins(
60        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
61        client_config: &crate::config::Config,
62        config_override: ::std::option::Option<crate::config::Builder>,
63    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
64        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
65
66        if let ::std::option::Option::Some(config_override) = config_override {
67            for plugin in config_override.runtime_plugins.iter().cloned() {
68                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
69            }
70            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
71                config_override,
72                client_config.config.clone(),
73                &client_config.runtime_components,
74            ));
75        }
76        runtime_plugins
77    }
78}
79impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for GetJob {
80    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
81        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("GetJob");
82
83        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
84            GetJobRequestSerializer,
85        ));
86        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
87            GetJobResponseDeserializer,
88        ));
89
90        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
91            crate::config::auth::Params::builder()
92                .operation_name("GetJob")
93                .build()
94                .expect("required fields set"),
95        ));
96
97        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
98        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("GetJob", "deadline"));
99        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
100        signing_options.double_uri_encode = true;
101        signing_options.content_sha256_header = false;
102        signing_options.normalize_uri_path = true;
103        signing_options.payload_override = None;
104
105        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
106            signing_options,
107            ..::std::default::Default::default()
108        });
109
110        ::std::option::Option::Some(cfg.freeze())
111    }
112
113    fn runtime_components(
114        &self,
115        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
116    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
117        #[allow(unused_mut)]
118        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("GetJob")
119            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
120            .with_interceptor(GetJobEndpointParamsInterceptor)
121            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
122                crate::operation::get_job::GetJobError,
123            >::new())
124            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
125                crate::operation::get_job::GetJobError,
126            >::new())
127            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
128                crate::operation::get_job::GetJobError,
129            >::new());
130
131        ::std::borrow::Cow::Owned(rcb)
132    }
133}
134
135#[derive(Debug)]
136struct GetJobResponseDeserializer;
137impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetJobResponseDeserializer {
138    fn deserialize_nonstreaming(
139        &self,
140        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
141    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
142        let (success, status) = (response.status().is_success(), response.status().as_u16());
143        let headers = response.headers();
144        let body = response.body().bytes().expect("body loaded");
145        #[allow(unused_mut)]
146        let mut force_error = false;
147        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
148        let parse_result = if !success && status != 200 || force_error {
149            crate::protocol_serde::shape_get_job::de_get_job_http_error(status, headers, body)
150        } else {
151            crate::protocol_serde::shape_get_job::de_get_job_http_response(status, headers, body)
152        };
153        crate::protocol_serde::type_erase_result(parse_result)
154    }
155}
156#[derive(Debug)]
157struct GetJobRequestSerializer;
158impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetJobRequestSerializer {
159    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
160    fn serialize_input(
161        &self,
162        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
163        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
164    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
165        let input = input.downcast::<crate::operation::get_job::GetJobInput>().expect("correct type");
166        let _header_serialization_settings = _cfg
167            .load::<crate::serialization_settings::HeaderSerializationSettings>()
168            .cloned()
169            .unwrap_or_default();
170        let mut request_builder = {
171            #[allow(clippy::uninlined_format_args)]
172            fn uri_base(
173                _input: &crate::operation::get_job::GetJobInput,
174                output: &mut ::std::string::String,
175            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
176                use ::std::fmt::Write as _;
177                let input_1 = &_input.farm_id;
178                let input_1 = input_1
179                    .as_ref()
180                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("farm_id", "cannot be empty or unset"))?;
181                let farm_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
182                if farm_id.is_empty() {
183                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
184                        "farm_id",
185                        "cannot be empty or unset",
186                    ));
187                }
188                let input_2 = &_input.queue_id;
189                let input_2 = input_2
190                    .as_ref()
191                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("queue_id", "cannot be empty or unset"))?;
192                let queue_id = ::aws_smithy_http::label::fmt_string(input_2, ::aws_smithy_http::label::EncodingStrategy::Default);
193                if queue_id.is_empty() {
194                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
195                        "queue_id",
196                        "cannot be empty or unset",
197                    ));
198                }
199                let input_3 = &_input.job_id;
200                let input_3 = input_3
201                    .as_ref()
202                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("job_id", "cannot be empty or unset"))?;
203                let job_id = ::aws_smithy_http::label::fmt_string(input_3, ::aws_smithy_http::label::EncodingStrategy::Default);
204                if job_id.is_empty() {
205                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
206                        "job_id",
207                        "cannot be empty or unset",
208                    ));
209                }
210                ::std::write!(
211                    output,
212                    "/2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId}",
213                    farmId = farm_id,
214                    queueId = queue_id,
215                    jobId = job_id
216                )
217                .expect("formatting should succeed");
218                ::std::result::Result::Ok(())
219            }
220            #[allow(clippy::unnecessary_wraps)]
221            fn update_http_builder(
222                input: &crate::operation::get_job::GetJobInput,
223                builder: ::http::request::Builder,
224            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
225                let mut uri = ::std::string::String::new();
226                uri_base(input, &mut uri)?;
227                ::std::result::Result::Ok(builder.method("GET").uri(uri))
228            }
229            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
230            builder
231        };
232        let body = ::aws_smithy_types::body::SdkBody::from("");
233
234        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
235    }
236}
237#[derive(Debug)]
238struct GetJobEndpointParamsInterceptor;
239
240impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetJobEndpointParamsInterceptor {
241    fn name(&self) -> &'static str {
242        "GetJobEndpointParamsInterceptor"
243    }
244
245    fn read_before_execution(
246        &self,
247        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
248            '_,
249            ::aws_smithy_runtime_api::client::interceptors::context::Input,
250            ::aws_smithy_runtime_api::client::interceptors::context::Output,
251            ::aws_smithy_runtime_api::client::interceptors::context::Error,
252        >,
253        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
254    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
255        let _input = context.input().downcast_ref::<GetJobInput>().ok_or("failed to downcast to GetJobInput")?;
256
257        let endpoint_prefix = ::aws_smithy_runtime_api::client::endpoint::EndpointPrefix::new("management.").map_err(|err| {
258            ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint prefix could not be built", err)
259        })?;
260        cfg.interceptor_state().store_put(endpoint_prefix);
261
262        let params = crate::config::endpoint::Params::builder()
263            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
264            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
265            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
266            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
267            .build()
268            .map_err(|err| {
269                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
270            })?;
271        cfg.interceptor_state()
272            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
273        ::std::result::Result::Ok(())
274    }
275}
276
277// The get_* functions below are generated from JMESPath expressions in the
278// operationContextParams trait. They target the operation's input shape.
279
280/// Error type for the `GetJobError` operation.
281#[non_exhaustive]
282#[derive(::std::fmt::Debug)]
283pub enum GetJobError {
284    /// <p>You don't have permission to perform the action.</p>
285    AccessDeniedException(crate::types::error::AccessDeniedException),
286    /// <p>Deadline Cloud can't process your request right now. Try again later.</p>
287    InternalServerErrorException(crate::types::error::InternalServerErrorException),
288    /// <p>The requested resource can't be found.</p>
289    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
290    /// <p>Your request exceeded a request rate quota.</p>
291    ThrottlingException(crate::types::error::ThrottlingException),
292    /// <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
293    ValidationException(crate::types::error::ValidationException),
294    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
295    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
296    variable wildcard pattern and check `.code()`:
297     \
298    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
299     \
300    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetJobError) for what information is available for the error.")]
301    Unhandled(crate::error::sealed_unhandled::Unhandled),
302}
303impl GetJobError {
304    /// Creates the `GetJobError::Unhandled` variant from any error type.
305    pub fn unhandled(
306        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
307    ) -> Self {
308        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
309            source: err.into(),
310            meta: ::std::default::Default::default(),
311        })
312    }
313
314    /// Creates the `GetJobError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
315    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
316        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
317            source: err.clone().into(),
318            meta: err,
319        })
320    }
321    ///
322    /// Returns error metadata, which includes the error code, message,
323    /// request ID, and potentially additional information.
324    ///
325    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
326        match self {
327            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
328            Self::InternalServerErrorException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
329            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
330            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
331            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
332            Self::Unhandled(e) => &e.meta,
333        }
334    }
335    /// Returns `true` if the error kind is `GetJobError::AccessDeniedException`.
336    pub fn is_access_denied_exception(&self) -> bool {
337        matches!(self, Self::AccessDeniedException(_))
338    }
339    /// Returns `true` if the error kind is `GetJobError::InternalServerErrorException`.
340    pub fn is_internal_server_error_exception(&self) -> bool {
341        matches!(self, Self::InternalServerErrorException(_))
342    }
343    /// Returns `true` if the error kind is `GetJobError::ResourceNotFoundException`.
344    pub fn is_resource_not_found_exception(&self) -> bool {
345        matches!(self, Self::ResourceNotFoundException(_))
346    }
347    /// Returns `true` if the error kind is `GetJobError::ThrottlingException`.
348    pub fn is_throttling_exception(&self) -> bool {
349        matches!(self, Self::ThrottlingException(_))
350    }
351    /// Returns `true` if the error kind is `GetJobError::ValidationException`.
352    pub fn is_validation_exception(&self) -> bool {
353        matches!(self, Self::ValidationException(_))
354    }
355}
356impl ::std::error::Error for GetJobError {
357    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
358        match self {
359            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
360            Self::InternalServerErrorException(_inner) => ::std::option::Option::Some(_inner),
361            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
362            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
363            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
364            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
365        }
366    }
367}
368impl ::std::fmt::Display for GetJobError {
369    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
370        match self {
371            Self::AccessDeniedException(_inner) => _inner.fmt(f),
372            Self::InternalServerErrorException(_inner) => _inner.fmt(f),
373            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
374            Self::ThrottlingException(_inner) => _inner.fmt(f),
375            Self::ValidationException(_inner) => _inner.fmt(f),
376            Self::Unhandled(_inner) => {
377                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
378                    write!(f, "unhandled error ({code})")
379                } else {
380                    f.write_str("unhandled error")
381                }
382            }
383        }
384    }
385}
386impl ::aws_smithy_types::retry::ProvideErrorKind for GetJobError {
387    fn code(&self) -> ::std::option::Option<&str> {
388        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
389    }
390    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
391        match self {
392            Self::InternalServerErrorException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
393            Self::ThrottlingException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
394            _ => ::std::option::Option::None,
395        }
396    }
397}
398impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetJobError {
399    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
400        match self {
401            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
402            Self::InternalServerErrorException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
403            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
404            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
405            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
406            Self::Unhandled(_inner) => &_inner.meta,
407        }
408    }
409}
410impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetJobError {
411    fn create_unhandled_error(
412        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
413        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
414    ) -> Self {
415        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
416            source,
417            meta: meta.unwrap_or_default(),
418        })
419    }
420}
421impl ::aws_types::request_id::RequestId for crate::operation::get_job::GetJobError {
422    fn request_id(&self) -> Option<&str> {
423        self.meta().request_id()
424    }
425}
426
427pub use crate::operation::get_job::_get_job_output::GetJobOutput;
428
429pub use crate::operation::get_job::_get_job_input::GetJobInput;
430
431mod _get_job_input;
432
433mod _get_job_output;
434
435/// Builders
436pub mod builders;