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

aws_sdk_iot/operation/
delete_job_execution.rs
