Skip to main content

aws_sdk_endusermessaging/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("EndUserMessaging", "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                "EndUserMessaging.GetJob",
51                "rpc.service" = "EndUserMessaging",
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::Metadata::new(
98            "GetJob",
99            "EndUserMessaging",
100        ));
101        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
102        signing_options.double_uri_encode = true;
103        signing_options.content_sha256_header = false;
104        signing_options.normalize_uri_path = true;
105        signing_options.payload_override = None;
106
107        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
108            signing_options,
109            ..::std::default::Default::default()
110        });
111
112        ::std::option::Option::Some(cfg.freeze())
113    }
114
115    fn runtime_components(
116        &self,
117        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
118    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
119        #[allow(unused_mut)]
120        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("GetJob")
121            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
122                GetJobTelemetryInputCaptureInterceptor,
123            ))
124            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
125                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
126            ))
127            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
128                GetJobEndpointParamsInterceptor,
129            ))
130            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
131                crate::operation::get_job::GetJobError,
132            >::new())
133            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
134                crate::operation::get_job::GetJobError,
135            >::new())
136            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
137                crate::operation::get_job::GetJobError,
138            >::new())
139            .with_retry_classifier(::aws_runtime::service_clock_skew::ServiceClockSkewClassifier::<
140                crate::operation::get_job::GetJobError,
141            >::new());
142
143        ::std::borrow::Cow::Owned(rcb)
144    }
145}
146
147#[derive(Debug)]
148struct GetJobTelemetryInputCaptureInterceptor;
149
150#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
151impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetJobTelemetryInputCaptureInterceptor {
152    fn name(&self) -> &'static str {
153        "GetJobTelemetryInputCaptureInterceptor"
154    }
155
156    fn read_before_execution(
157        &self,
158        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
159            '_,
160            ::aws_smithy_runtime_api::client::interceptors::context::Input,
161            ::aws_smithy_runtime_api::client::interceptors::context::Output,
162            ::aws_smithy_runtime_api::client::interceptors::context::Error,
163        >,
164        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
165    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
166        // Nothing to do unless the customer opted in by naming members to record.
167        let ::std::option::Option::Some(requested) = cfg
168            .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
169            .filter(|r| !r.is_empty())
170        else {
171            return ::std::result::Result::Ok(());
172        };
173
174        let ::std::option::Option::Some(input) = context.input().downcast_ref::<GetJobInput>() else {
175            // A mismatched input is not this interceptor's concern; skip quietly.
176            return ::std::result::Result::Ok(());
177        };
178
179        let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
180        if requested.should_capture("jobId") {
181            if let ::std::option::Option::Some(value) = input.job_id.as_deref() {
182                captured.insert("jobId", value);
183            }
184        }
185
186        cfg.interceptor_state().store_put(captured);
187        ::std::result::Result::Ok(())
188    }
189}
190#[derive(Debug)]
191struct GetJobResponseDeserializer;
192impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetJobResponseDeserializer {
193    fn deserialize_nonstreaming_with_config(
194        &self,
195        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
196        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
197    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
198        let (success, status) = (response.status().is_success(), response.status().as_u16());
199        let headers = response.headers();
200        let body = response.body().bytes().expect("body loaded");
201        #[allow(unused_mut)]
202        let mut force_error = false;
203        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
204        let parse_result = if !success && status != 200 || force_error {
205            crate::protocol_serde::shape_get_job::de_get_job_http_error(status, headers, body, _cfg)
206        } else {
207            crate::protocol_serde::shape_get_job::de_get_job_http_response(status, headers, body, _cfg)
208        };
209        crate::protocol_serde::type_erase_result(parse_result)
210    }
211}
212#[derive(Debug)]
213struct GetJobRequestSerializer;
214impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetJobRequestSerializer {
215    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
216    fn serialize_input(
217        &self,
218        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
219        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
220    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
221        let input = input.downcast::<crate::operation::get_job::GetJobInput>().expect("correct type");
222        let _header_serialization_settings = _cfg
223            .load::<crate::serialization_settings::HeaderSerializationSettings>()
224            .cloned()
225            .unwrap_or_default();
226        let mut request_builder = {
227            #[allow(clippy::uninlined_format_args)]
228            fn uri_base(
229                _input: &crate::operation::get_job::GetJobInput,
230                output: &mut ::std::string::String,
231            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
232                use ::std::fmt::Write as _;
233                let input_1 = &_input.job_id;
234                let input_1 = input_1
235                    .as_ref()
236                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("job_id", "cannot be empty or unset"))?;
237                let job_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
238                if job_id.is_empty() {
239                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
240                        "job_id",
241                        "cannot be empty or unset",
242                    ));
243                }
244                ::std::write!(output, "/v1/jobs/{jobId}", jobId = job_id).expect("formatting should succeed");
245                ::std::result::Result::Ok(())
246            }
247            #[allow(clippy::unnecessary_wraps)]
248            fn update_http_builder(
249                input: &crate::operation::get_job::GetJobInput,
250                builder: ::http_1x::request::Builder,
251            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
252                let mut uri = ::std::string::String::new();
253                uri_base(input, &mut uri)?;
254                ::std::result::Result::Ok(builder.method("GET").uri(uri))
255            }
256            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
257            builder
258        };
259        let body = ::aws_smithy_types::body::SdkBody::from("");
260
261        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
262    }
263}
264#[derive(Debug)]
265struct GetJobEndpointParamsInterceptor;
266
267#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
268impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetJobEndpointParamsInterceptor {
269    fn name(&self) -> &'static str {
270        "GetJobEndpointParamsInterceptor"
271    }
272
273    fn read_before_execution(
274        &self,
275        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
276            '_,
277            ::aws_smithy_runtime_api::client::interceptors::context::Input,
278            ::aws_smithy_runtime_api::client::interceptors::context::Output,
279            ::aws_smithy_runtime_api::client::interceptors::context::Error,
280        >,
281        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
282    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
283        let _input = context.input().downcast_ref::<GetJobInput>().ok_or("failed to downcast to GetJobInput")?;
284
285        let params = crate::config::endpoint::Params::builder()
286            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
287            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
288            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
289            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
290            .build()
291            .map_err(|err| {
292                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
293            })?;
294        cfg.interceptor_state()
295            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
296        ::std::result::Result::Ok(())
297    }
298}
299
300// The get_* functions below are generated from JMESPath expressions in the
301// operationContextParams trait. They target the operation's input shape.
302
303/// Error type for the `GetJobError` operation.
304#[non_exhaustive]
305#[derive(::std::fmt::Debug)]
306pub enum GetJobError {
307    /// <p>You do not have sufficient access to perform this action.</p>
308    AccessDeniedException(crate::types::error::AccessDeniedException),
309    /// <p>An unexpected error occurred during the processing of the request.</p>
310    InternalServerException(crate::types::error::InternalServerException),
311    /// <p>The request references a resource that does not exist. Verify that the resource identifier is correct and try your request again.</p>
312    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
313    /// <p>The request was denied because it exceeded the allowed request rate.</p>
314    ThrottlingException(crate::types::error::ThrottlingException),
315    /// A standard error for input validation failures. This should be thrown by services when a member of the input structure falls outside of the modeled or documented constraints.
316    ValidationException(crate::types::error::ValidationException),
317    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
318    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
319    variable wildcard pattern and check `.code()`:
320     \
321    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
322     \
323    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetJobError) for what information is available for the error.")]
324    Unhandled(crate::error::sealed_unhandled::Unhandled),
325}
326impl GetJobError {
327    /// Creates the `GetJobError::Unhandled` variant from any error type.
328    pub fn unhandled(
329        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
330    ) -> Self {
331        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
332            source: err.into(),
333            meta: ::std::default::Default::default(),
334        })
335    }
336
337    /// Creates the `GetJobError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
338    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
339        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
340            source: err.clone().into(),
341            meta: err,
342        })
343    }
344    ///
345    /// Returns error metadata, which includes the error code, message,
346    /// request ID, and potentially additional information.
347    ///
348    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
349        match self {
350            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
351            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
352            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
353            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
354            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
355            Self::Unhandled(e) => &e.meta,
356        }
357    }
358    /// Returns `true` if the error kind is `GetJobError::AccessDeniedException`.
359    pub fn is_access_denied_exception(&self) -> bool {
360        matches!(self, Self::AccessDeniedException(_))
361    }
362    /// Returns `true` if the error kind is `GetJobError::InternalServerException`.
363    pub fn is_internal_server_exception(&self) -> bool {
364        matches!(self, Self::InternalServerException(_))
365    }
366    /// Returns `true` if the error kind is `GetJobError::ResourceNotFoundException`.
367    pub fn is_resource_not_found_exception(&self) -> bool {
368        matches!(self, Self::ResourceNotFoundException(_))
369    }
370    /// Returns `true` if the error kind is `GetJobError::ThrottlingException`.
371    pub fn is_throttling_exception(&self) -> bool {
372        matches!(self, Self::ThrottlingException(_))
373    }
374    /// Returns `true` if the error kind is `GetJobError::ValidationException`.
375    pub fn is_validation_exception(&self) -> bool {
376        matches!(self, Self::ValidationException(_))
377    }
378}
379impl ::std::error::Error for GetJobError {
380    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
381        match self {
382            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
383            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
384            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
385            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
386            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
387            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
388        }
389    }
390}
391impl ::std::fmt::Display for GetJobError {
392    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
393        match self {
394            Self::AccessDeniedException(_inner) => _inner.fmt(f),
395            Self::InternalServerException(_inner) => _inner.fmt(f),
396            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
397            Self::ThrottlingException(_inner) => _inner.fmt(f),
398            Self::ValidationException(_inner) => _inner.fmt(f),
399            Self::Unhandled(_inner) => {
400                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
401                    write!(f, "unhandled error ({code})")
402                } else {
403                    f.write_str("unhandled error")
404                }
405            }
406        }
407    }
408}
409impl ::aws_smithy_types::retry::ProvideErrorKind for GetJobError {
410    fn code(&self) -> ::std::option::Option<&str> {
411        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
412    }
413    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
414        match self {
415            Self::InternalServerException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
416            Self::ThrottlingException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
417            _ => ::std::option::Option::None,
418        }
419    }
420}
421impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetJobError {
422    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
423        match self {
424            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
425            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
426            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
427            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
428            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
429            Self::Unhandled(_inner) => &_inner.meta,
430        }
431    }
432}
433impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetJobError {
434    fn create_unhandled_error(
435        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
436        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
437    ) -> Self {
438        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
439            source,
440            meta: meta.unwrap_or_default(),
441        })
442    }
443}
444impl ::aws_types::request_id::RequestId for crate::operation::get_job::GetJobError {
445    fn request_id(&self) -> Option<&str> {
446        self.meta().request_id()
447    }
448}
449
450pub use crate::operation::get_job::_get_job_input::GetJobInput;
451
452pub use crate::operation::get_job::_get_job_output::GetJobOutput;
453
454mod _get_job_input;
455
456mod _get_job_output;
457
458/// Builders
459pub mod builders;