aws_sdk_iot/operation/
delete_job_execution.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DeleteJobExecution`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DeleteJobExecution;
6impl DeleteJobExecution {
7    /// Creates a new `DeleteJobExecution`
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_execution::DeleteJobExecutionInput,
14    ) -> ::std::result::Result<
15        crate::operation::delete_job_execution::DeleteJobExecutionOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::delete_job_execution::DeleteJobExecutionError,
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_execution::DeleteJobExecutionError>()
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_execution::DeleteJobExecutionOutput>()
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_execution::DeleteJobExecutionInput,
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", "DeleteJobExecution", 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.DeleteJobExecution",
59                "rpc.service" = "IoT",
60                "rpc.method" = "DeleteJobExecution",
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 DeleteJobExecution {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DeleteJobExecution");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            DeleteJobExecutionRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            DeleteJobExecutionResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("DeleteJobExecution")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("DeleteJobExecution", "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("DeleteJobExecution")
126            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
127            .with_interceptor(DeleteJobExecutionEndpointParamsInterceptor)
128            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
129                crate::operation::delete_job_execution::DeleteJobExecutionError,
130            >::new())
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
132                crate::operation::delete_job_execution::DeleteJobExecutionError,
133            >::new())
134            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
135                crate::operation::delete_job_execution::DeleteJobExecutionError,
136            >::new());
137
138        ::std::borrow::Cow::Owned(rcb)
139    }
140}
141
142#[derive(Debug)]
143struct DeleteJobExecutionResponseDeserializer;
144impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DeleteJobExecutionResponseDeserializer {
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_execution::de_delete_job_execution_http_error(status, headers, body)
157        } else {
158            crate::protocol_serde::shape_delete_job_execution::de_delete_job_execution_http_response(status, headers, body)
159        };
160        crate::protocol_serde::type_erase_result(parse_result)
161    }
162}
163#[derive(Debug)]
164struct DeleteJobExecutionRequestSerializer;
165impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DeleteJobExecutionRequestSerializer {
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
173            .downcast::<crate::operation::delete_job_execution::DeleteJobExecutionInput>()
174            .expect("correct type");
175        let _header_serialization_settings = _cfg
176            .load::<crate::serialization_settings::HeaderSerializationSettings>()
177            .cloned()
178            .unwrap_or_default();
179        let mut request_builder = {
180            fn uri_base(
181                _input: &crate::operation::delete_job_execution::DeleteJobExecutionInput,
182                output: &mut ::std::string::String,
183            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
184                use ::std::fmt::Write as _;
185                let input_1 = &_input.thing_name;
186                let input_1 = input_1
187                    .as_ref()
188                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("thing_name", "cannot be empty or unset"))?;
189                let thing_name = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
190                if thing_name.is_empty() {
191                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
192                        "thing_name",
193                        "cannot be empty or unset",
194                    ));
195                }
196                let input_2 = &_input.job_id;
197                let input_2 = input_2
198                    .as_ref()
199                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("job_id", "cannot be empty or unset"))?;
200                let job_id = ::aws_smithy_http::label::fmt_string(input_2, ::aws_smithy_http::label::EncodingStrategy::Default);
201                if job_id.is_empty() {
202                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
203                        "job_id",
204                        "cannot be empty or unset",
205                    ));
206                }
207                let input_3 = &_input.execution_number;
208                let input_3 = input_3
209                    .as_ref()
210                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("execution_number", "cannot be empty or unset"))?;
211                let mut execution_number_encoder = ::aws_smithy_types::primitive::Encoder::from(*input_3);
212                let execution_number = execution_number_encoder.encode();
213                if execution_number.is_empty() {
214                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
215                        "execution_number",
216                        "cannot be empty or unset",
217                    ));
218                }
219                ::std::write!(
220                    output,
221                    "/things/{thingName}/jobs/{jobId}/executionNumber/{executionNumber}",
222                    thingName = thing_name,
223                    jobId = job_id,
224                    executionNumber = execution_number
225                )
226                .expect("formatting should succeed");
227                ::std::result::Result::Ok(())
228            }
229            fn uri_query(
230                _input: &crate::operation::delete_job_execution::DeleteJobExecutionInput,
231                mut output: &mut ::std::string::String,
232            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
233                let mut query = ::aws_smithy_http::query::Writer::new(output);
234                if let ::std::option::Option::Some(inner_4) = &_input.force {
235                    {
236                        query.push_kv("force", ::aws_smithy_types::primitive::Encoder::from(*inner_4).encode());
237                    }
238                }
239                if let ::std::option::Option::Some(inner_5) = &_input.namespace_id {
240                    {
241                        query.push_kv("namespaceId", &::aws_smithy_http::query::fmt_string(inner_5));
242                    }
243                }
244                ::std::result::Result::Ok(())
245            }
246            #[allow(clippy::unnecessary_wraps)]
247            fn update_http_builder(
248                input: &crate::operation::delete_job_execution::DeleteJobExecutionInput,
249                builder: ::http::request::Builder,
250            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
251                let mut uri = ::std::string::String::new();
252                uri_base(input, &mut uri)?;
253                uri_query(input, &mut uri)?;
254                ::std::result::Result::Ok(builder.method("DELETE").uri(uri))
255            }
256            let mut builder = update_http_builder(&input, ::http::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 DeleteJobExecutionEndpointParamsInterceptor;
266
267impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DeleteJobExecutionEndpointParamsInterceptor {
268    fn name(&self) -> &'static str {
269        "DeleteJobExecutionEndpointParamsInterceptor"
270    }
271
272    fn read_before_execution(
273        &self,
274        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
275            '_,
276            ::aws_smithy_runtime_api::client::interceptors::context::Input,
277            ::aws_smithy_runtime_api::client::interceptors::context::Output,
278            ::aws_smithy_runtime_api::client::interceptors::context::Error,
279        >,
280        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
281    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
282        let _input = context
283            .input()
284            .downcast_ref::<DeleteJobExecutionInput>()
285            .ok_or("failed to downcast to DeleteJobExecutionInput")?;
286
287        let params = crate::config::endpoint::Params::builder()
288            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
289            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
290            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
291            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
292            .build()
293            .map_err(|err| {
294                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
295            })?;
296        cfg.interceptor_state()
297            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
298        ::std::result::Result::Ok(())
299    }
300}
301
302// The get_* functions below are generated from JMESPath expressions in the
303// operationContextParams trait. They target the operation's input shape.
304
305/// Error type for the `DeleteJobExecutionError` operation.
306#[non_exhaustive]
307#[derive(::std::fmt::Debug)]
308pub enum DeleteJobExecutionError {
309    /// <p>The request is not valid.</p>
310    InvalidRequestException(crate::types::error::InvalidRequestException),
311    /// <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>
312    InvalidStateTransitionException(crate::types::error::InvalidStateTransitionException),
313    /// <p>The specified resource does not exist.</p>
314    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
315    /// <p>The service is temporarily unavailable.</p>
316    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
317    /// <p>The rate exceeds the limit.</p>
318    ThrottlingException(crate::types::error::ThrottlingException),
319    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
320    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
321    variable wildcard pattern and check `.code()`:
322     \
323    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
324     \
325    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DeleteJobExecutionError) for what information is available for the error.")]
326    Unhandled(crate::error::sealed_unhandled::Unhandled),
327}
328impl DeleteJobExecutionError {
329    /// Creates the `DeleteJobExecutionError::Unhandled` variant from any error type.
330    pub fn unhandled(
331        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
332    ) -> Self {
333        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
334            source: err.into(),
335            meta: ::std::default::Default::default(),
336        })
337    }
338
339    /// Creates the `DeleteJobExecutionError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
340    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
341        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
342            source: err.clone().into(),
343            meta: err,
344        })
345    }
346    ///
347    /// Returns error metadata, which includes the error code, message,
348    /// request ID, and potentially additional information.
349    ///
350    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
351        match self {
352            Self::InvalidRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
353            Self::InvalidStateTransitionException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
354            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
355            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
356            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
357            Self::Unhandled(e) => &e.meta,
358        }
359    }
360    /// Returns `true` if the error kind is `DeleteJobExecutionError::InvalidRequestException`.
361    pub fn is_invalid_request_exception(&self) -> bool {
362        matches!(self, Self::InvalidRequestException(_))
363    }
364    /// Returns `true` if the error kind is `DeleteJobExecutionError::InvalidStateTransitionException`.
365    pub fn is_invalid_state_transition_exception(&self) -> bool {
366        matches!(self, Self::InvalidStateTransitionException(_))
367    }
368    /// Returns `true` if the error kind is `DeleteJobExecutionError::ResourceNotFoundException`.
369    pub fn is_resource_not_found_exception(&self) -> bool {
370        matches!(self, Self::ResourceNotFoundException(_))
371    }
372    /// Returns `true` if the error kind is `DeleteJobExecutionError::ServiceUnavailableException`.
373    pub fn is_service_unavailable_exception(&self) -> bool {
374        matches!(self, Self::ServiceUnavailableException(_))
375    }
376    /// Returns `true` if the error kind is `DeleteJobExecutionError::ThrottlingException`.
377    pub fn is_throttling_exception(&self) -> bool {
378        matches!(self, Self::ThrottlingException(_))
379    }
380}
381impl ::std::error::Error for DeleteJobExecutionError {
382    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
383        match self {
384            Self::InvalidRequestException(_inner) => ::std::option::Option::Some(_inner),
385            Self::InvalidStateTransitionException(_inner) => ::std::option::Option::Some(_inner),
386            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
387            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
388            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
389            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
390        }
391    }
392}
393impl ::std::fmt::Display for DeleteJobExecutionError {
394    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
395        match self {
396            Self::InvalidRequestException(_inner) => _inner.fmt(f),
397            Self::InvalidStateTransitionException(_inner) => _inner.fmt(f),
398            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
399            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
400            Self::ThrottlingException(_inner) => _inner.fmt(f),
401            Self::Unhandled(_inner) => {
402                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
403                    write!(f, "unhandled error ({code})")
404                } else {
405                    f.write_str("unhandled error")
406                }
407            }
408        }
409    }
410}
411impl ::aws_smithy_types::retry::ProvideErrorKind for DeleteJobExecutionError {
412    fn code(&self) -> ::std::option::Option<&str> {
413        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
414    }
415    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
416        ::std::option::Option::None
417    }
418}
419impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DeleteJobExecutionError {
420    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
421        match self {
422            Self::InvalidRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
423            Self::InvalidStateTransitionException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
424            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
425            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
426            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
427            Self::Unhandled(_inner) => &_inner.meta,
428        }
429    }
430}
431impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DeleteJobExecutionError {
432    fn create_unhandled_error(
433        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
434        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
435    ) -> Self {
436        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
437            source,
438            meta: meta.unwrap_or_default(),
439        })
440    }
441}
442impl ::aws_types::request_id::RequestId for crate::operation::delete_job_execution::DeleteJobExecutionError {
443    fn request_id(&self) -> Option<&str> {
444        self.meta().request_id()
445    }
446}
447
448pub use crate::operation::delete_job_execution::_delete_job_execution_output::DeleteJobExecutionOutput;
449
450pub use crate::operation::delete_job_execution::_delete_job_execution_input::DeleteJobExecutionInput;
451
452mod _delete_job_execution_input;
453
454mod _delete_job_execution_output;
455
456/// Builders
457pub mod builders;
aws_sdk_iot/operation/delete_job_execution.rs

aws_sdk_iot/operation/
delete_job_execution.rs
