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