aws_sdk_iot/operation/
cancel_job_execution.rs

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

aws_sdk_iot/operation/
cancel_job_execution.rs
