aws_sdk_iot/operation/
delete_job.rs

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

aws_sdk_iot/operation/
delete_job.rs
