Skip to main content

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