aws_sdk_ssm/operation/
list_commands.rs

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

aws_sdk_ssm/operation/
list_commands.rs
