aws_sdk_ssm/operation/
cancel_command.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `CancelCommand`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct CancelCommand;
6impl CancelCommand {
7    /// Creates a new `CancelCommand`
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_command::CancelCommandInput,
14    ) -> ::std::result::Result<
15        crate::operation::cancel_command::CancelCommandOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::cancel_command::CancelCommandError,
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_command::CancelCommandError>()
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_command::CancelCommandOutput>()
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_command::CancelCommandInput,
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("SSM", "CancelCommand", 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                "SSM.CancelCommand",
59                "rpc.service" = "SSM",
60                "rpc.method" = "CancelCommand",
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 CancelCommand {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("CancelCommand");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            CancelCommandRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            CancelCommandResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("CancelCommand")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("CancelCommand", "SSM"));
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("CancelCommand")
126            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
127                CancelCommandTelemetryInputCaptureInterceptor,
128            ))
129            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
130                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
131            ))
132            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
133                CancelCommandEndpointParamsInterceptor,
134            ))
135            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
136                crate::operation::cancel_command::CancelCommandError,
137            >::new())
138            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
139                crate::operation::cancel_command::CancelCommandError,
140            >::new())
141            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
142                crate::operation::cancel_command::CancelCommandError,
143            >::new())
144            .with_retry_classifier(::aws_runtime::service_clock_skew::ServiceClockSkewClassifier::<
145                crate::operation::cancel_command::CancelCommandError,
146            >::new());
147
148        ::std::borrow::Cow::Owned(rcb)
149    }
150}
151
152#[derive(Debug)]
153struct CancelCommandTelemetryInputCaptureInterceptor;
154
155#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
156impl ::aws_smithy_runtime_api::client::interceptors::Intercept for CancelCommandTelemetryInputCaptureInterceptor {
157    fn name(&self) -> &'static str {
158        "CancelCommandTelemetryInputCaptureInterceptor"
159    }
160
161    fn read_before_execution(
162        &self,
163        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
164            '_,
165            ::aws_smithy_runtime_api::client::interceptors::context::Input,
166            ::aws_smithy_runtime_api::client::interceptors::context::Output,
167            ::aws_smithy_runtime_api::client::interceptors::context::Error,
168        >,
169        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
170    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
171        // Nothing to do unless the customer opted in by naming members to record.
172        let ::std::option::Option::Some(requested) = cfg
173            .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
174            .filter(|r| !r.is_empty())
175        else {
176            return ::std::result::Result::Ok(());
177        };
178
179        let ::std::option::Option::Some(input) = context.input().downcast_ref::<CancelCommandInput>() else {
180            // A mismatched input is not this interceptor's concern; skip quietly.
181            return ::std::result::Result::Ok(());
182        };
183
184        let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
185        if requested.should_capture("CommandId") {
186            if let ::std::option::Option::Some(value) = input.command_id.as_deref() {
187                captured.insert("CommandId", value);
188            }
189        }
190
191        cfg.interceptor_state().store_put(captured);
192        ::std::result::Result::Ok(())
193    }
194}
195#[derive(Debug)]
196struct CancelCommandResponseDeserializer;
197impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for CancelCommandResponseDeserializer {
198    fn deserialize_nonstreaming_with_config(
199        &self,
200        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
201        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
202    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
203        let (success, status) = (response.status().is_success(), response.status().as_u16());
204        let headers = response.headers();
205        let body = response.body().bytes().expect("body loaded");
206        #[allow(unused_mut)]
207        let mut force_error = false;
208        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
209        let parse_result = if !success && status != 200 || force_error {
210            crate::protocol_serde::shape_cancel_command::de_cancel_command_http_error(status, headers, body)
211        } else {
212            crate::protocol_serde::shape_cancel_command::de_cancel_command_http_response(status, headers, body)
213        };
214        crate::protocol_serde::type_erase_result(parse_result)
215    }
216}
217#[derive(Debug)]
218struct CancelCommandRequestSerializer;
219impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for CancelCommandRequestSerializer {
220    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
221    fn serialize_input(
222        &self,
223        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
224        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
225    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
226        let input = input
227            .downcast::<crate::operation::cancel_command::CancelCommandInput>()
228            .expect("correct type");
229        let _header_serialization_settings = _cfg
230            .load::<crate::serialization_settings::HeaderSerializationSettings>()
231            .cloned()
232            .unwrap_or_default();
233        let mut request_builder = {
234            #[allow(clippy::uninlined_format_args)]
235            fn uri_base(
236                _input: &crate::operation::cancel_command::CancelCommandInput,
237                output: &mut ::std::string::String,
238            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
239                use ::std::fmt::Write as _;
240                ::std::write!(output, "/").expect("formatting should succeed");
241                ::std::result::Result::Ok(())
242            }
243            #[allow(clippy::unnecessary_wraps)]
244            fn update_http_builder(
245                input: &crate::operation::cancel_command::CancelCommandInput,
246                builder: ::http_1x::request::Builder,
247            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
248                let mut uri = ::std::string::String::new();
249                uri_base(input, &mut uri)?;
250                ::std::result::Result::Ok(builder.method("POST").uri(uri))
251            }
252            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
253            builder = _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/x-amz-json-1.1");
254            builder = _header_serialization_settings.set_default_header(
255                builder,
256                ::http_1x::header::HeaderName::from_static("x-amz-target"),
257                "AmazonSSM.CancelCommand",
258            );
259            builder
260        };
261        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_cancel_command::ser_cancel_command_input(&input)?);
262        if let Some(content_length) = body.content_length() {
263            let content_length = content_length.to_string();
264            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http_1x::header::CONTENT_LENGTH, &content_length);
265        }
266        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
267    }
268}
269#[derive(Debug)]
270struct CancelCommandEndpointParamsInterceptor;
271
272#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
273impl ::aws_smithy_runtime_api::client::interceptors::Intercept for CancelCommandEndpointParamsInterceptor {
274    fn name(&self) -> &'static str {
275        "CancelCommandEndpointParamsInterceptor"
276    }
277
278    fn read_before_execution(
279        &self,
280        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
281            '_,
282            ::aws_smithy_runtime_api::client::interceptors::context::Input,
283            ::aws_smithy_runtime_api::client::interceptors::context::Output,
284            ::aws_smithy_runtime_api::client::interceptors::context::Error,
285        >,
286        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
287    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
288        let _input = context
289            .input()
290            .downcast_ref::<CancelCommandInput>()
291            .ok_or("failed to downcast to CancelCommandInput")?;
292
293        let params = crate::config::endpoint::Params::builder()
294            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
295            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
296            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
297            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
298            .build()
299            .map_err(|err| {
300                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
301            })?;
302        cfg.interceptor_state()
303            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
304        ::std::result::Result::Ok(())
305    }
306}
307
308// The get_* functions below are generated from JMESPath expressions in the
309// operationContextParams trait. They target the operation's input shape.
310
311/// Error type for the `CancelCommandError` operation.
312#[non_exhaustive]
313#[derive(::std::fmt::Debug)]
314pub enum CancelCommandError {
315    /// <p>You can't specify a managed node ID in more than one association.</p>
316    DuplicateInstanceId(crate::types::error::DuplicateInstanceId),
317    /// <p>An error occurred on the server side.</p>
318    InternalServerError(crate::types::error::InternalServerError),
319    /// <p>The specified command ID isn't valid. Verify the ID and try again.</p>
320    InvalidCommandId(crate::types::error::InvalidCommandId),
321    /// <p>The following problems can cause this exception:</p>
322    /// <ul>
323    /// <li>
324    /// <p>You don't have permission to access the managed node.</p></li>
325    /// <li>
326    /// <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is running.</p></li>
327    /// <li>
328    /// <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p></li>
329    /// <li>
330    /// <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>, <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are: <code>Shutting-down</code> and <code>Terminated</code>.</p></li>
331    /// </ul>
332    InvalidInstanceId(crate::types::error::InvalidInstanceId),
333    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
334    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
335    variable wildcard pattern and check `.code()`:
336     \
337    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
338     \
339    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-CancelCommandError) for what information is available for the error.")]
340    Unhandled(crate::error::sealed_unhandled::Unhandled),
341}
342impl CancelCommandError {
343    /// Creates the `CancelCommandError::Unhandled` variant from any error type.
344    pub fn unhandled(
345        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
346    ) -> Self {
347        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
348            source: err.into(),
349            meta: ::std::default::Default::default(),
350        })
351    }
352
353    /// Creates the `CancelCommandError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
354    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
355        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
356            source: err.clone().into(),
357            meta: err,
358        })
359    }
360    ///
361    /// Returns error metadata, which includes the error code, message,
362    /// request ID, and potentially additional information.
363    ///
364    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
365        match self {
366            Self::DuplicateInstanceId(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
367            Self::InternalServerError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
368            Self::InvalidCommandId(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
369            Self::InvalidInstanceId(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
370            Self::Unhandled(e) => &e.meta,
371        }
372    }
373    /// Returns `true` if the error kind is `CancelCommandError::DuplicateInstanceId`.
374    pub fn is_duplicate_instance_id(&self) -> bool {
375        matches!(self, Self::DuplicateInstanceId(_))
376    }
377    /// Returns `true` if the error kind is `CancelCommandError::InternalServerError`.
378    pub fn is_internal_server_error(&self) -> bool {
379        matches!(self, Self::InternalServerError(_))
380    }
381    /// Returns `true` if the error kind is `CancelCommandError::InvalidCommandId`.
382    pub fn is_invalid_command_id(&self) -> bool {
383        matches!(self, Self::InvalidCommandId(_))
384    }
385    /// Returns `true` if the error kind is `CancelCommandError::InvalidInstanceId`.
386    pub fn is_invalid_instance_id(&self) -> bool {
387        matches!(self, Self::InvalidInstanceId(_))
388    }
389}
390impl ::std::error::Error for CancelCommandError {
391    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
392        match self {
393            Self::DuplicateInstanceId(_inner) => ::std::option::Option::Some(_inner),
394            Self::InternalServerError(_inner) => ::std::option::Option::Some(_inner),
395            Self::InvalidCommandId(_inner) => ::std::option::Option::Some(_inner),
396            Self::InvalidInstanceId(_inner) => ::std::option::Option::Some(_inner),
397            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
398        }
399    }
400}
401impl ::std::fmt::Display for CancelCommandError {
402    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
403        match self {
404            Self::DuplicateInstanceId(_inner) => _inner.fmt(f),
405            Self::InternalServerError(_inner) => _inner.fmt(f),
406            Self::InvalidCommandId(_inner) => _inner.fmt(f),
407            Self::InvalidInstanceId(_inner) => _inner.fmt(f),
408            Self::Unhandled(_inner) => {
409                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
410                    write!(f, "unhandled error ({code})")
411                } else {
412                    f.write_str("unhandled error")
413                }
414            }
415        }
416    }
417}
418impl ::aws_smithy_types::retry::ProvideErrorKind for CancelCommandError {
419    fn code(&self) -> ::std::option::Option<&str> {
420        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
421    }
422    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
423        ::std::option::Option::None
424    }
425}
426impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for CancelCommandError {
427    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
428        match self {
429            Self::DuplicateInstanceId(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
430            Self::InternalServerError(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
431            Self::InvalidCommandId(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
432            Self::InvalidInstanceId(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
433            Self::Unhandled(_inner) => &_inner.meta,
434        }
435    }
436}
437impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for CancelCommandError {
438    fn create_unhandled_error(
439        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
440        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
441    ) -> Self {
442        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
443            source,
444            meta: meta.unwrap_or_default(),
445        })
446    }
447}
448impl ::aws_types::request_id::RequestId for crate::operation::cancel_command::CancelCommandError {
449    fn request_id(&self) -> Option<&str> {
450        self.meta().request_id()
451    }
452}
453
454pub use crate::operation::cancel_command::_cancel_command_input::CancelCommandInput;
455
456pub use crate::operation::cancel_command::_cancel_command_output::CancelCommandOutput;
457
458mod _cancel_command_input;
459
460mod _cancel_command_output;
461
462/// Builders
463pub mod builders;
aws_sdk_ssm/operation/cancel_command.rs

aws_sdk_ssm/operation/
cancel_command.rs
