aws_sdk_efs/operation/
describe_file_systems.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeFileSystems`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeFileSystems;
6impl DescribeFileSystems {
7    /// Creates a new `DescribeFileSystems`
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::describe_file_systems::DescribeFileSystemsInput,
14    ) -> ::std::result::Result<
15        crate::operation::describe_file_systems::DescribeFileSystemsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_file_systems::DescribeFileSystemsError,
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::describe_file_systems::DescribeFileSystemsError>()
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::describe_file_systems::DescribeFileSystemsOutput>()
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::describe_file_systems::DescribeFileSystemsInput,
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("EFS", "DescribeFileSystems", 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                "EFS.DescribeFileSystems",
59                "rpc.service" = "EFS",
60                "rpc.method" = "DescribeFileSystems",
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 DescribeFileSystems {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeFileSystems");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            DescribeFileSystemsRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            DescribeFileSystemsResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("DescribeFileSystems")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "DescribeFileSystems",
107            "EFS",
108        ));
109        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
110        signing_options.double_uri_encode = true;
111        signing_options.content_sha256_header = false;
112        signing_options.normalize_uri_path = true;
113        signing_options.payload_override = None;
114
115        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
116            signing_options,
117            ..::std::default::Default::default()
118        });
119
120        ::std::option::Option::Some(cfg.freeze())
121    }
122
123    fn runtime_components(
124        &self,
125        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
126    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
127        #[allow(unused_mut)]
128        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("DescribeFileSystems")
129            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
130                DescribeFileSystemsTelemetryInputCaptureInterceptor,
131            ))
132            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
133                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
134            ))
135            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
136                DescribeFileSystemsEndpointParamsInterceptor,
137            ))
138            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
139                crate::operation::describe_file_systems::DescribeFileSystemsError,
140            >::new())
141            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
142                crate::operation::describe_file_systems::DescribeFileSystemsError,
143            >::new())
144            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
145                crate::operation::describe_file_systems::DescribeFileSystemsError,
146            >::new());
147
148        ::std::borrow::Cow::Owned(rcb)
149    }
150}
151
152#[derive(Debug)]
153struct DescribeFileSystemsTelemetryInputCaptureInterceptor;
154
155#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
156impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeFileSystemsTelemetryInputCaptureInterceptor {
157    fn name(&self) -> &'static str {
158        "DescribeFileSystemsTelemetryInputCaptureInterceptor"
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::<DescribeFileSystemsInput>() 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("Marker") {
186            if let ::std::option::Option::Some(value) = input.marker.as_deref() {
187                captured.insert("Marker", value);
188            }
189        }
190        if requested.should_capture("CreationToken") {
191            if let ::std::option::Option::Some(value) = input.creation_token.as_deref() {
192                captured.insert("CreationToken", value);
193            }
194        }
195        if requested.should_capture("FileSystemId") {
196            if let ::std::option::Option::Some(value) = input.file_system_id.as_deref() {
197                captured.insert("FileSystemId", value);
198            }
199        }
200
201        cfg.interceptor_state().store_put(captured);
202        ::std::result::Result::Ok(())
203    }
204}
205#[derive(Debug)]
206struct DescribeFileSystemsResponseDeserializer;
207impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeFileSystemsResponseDeserializer {
208    fn deserialize_nonstreaming_with_config(
209        &self,
210        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
211        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
212    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
213        let (success, status) = (response.status().is_success(), response.status().as_u16());
214        let headers = response.headers();
215        let body = response.body().bytes().expect("body loaded");
216        #[allow(unused_mut)]
217        let mut force_error = false;
218        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
219        let parse_result = if !success && status != 200 || force_error {
220            crate::protocol_serde::shape_describe_file_systems::de_describe_file_systems_http_error(status, headers, body)
221        } else {
222            crate::protocol_serde::shape_describe_file_systems::de_describe_file_systems_http_response(status, headers, body)
223        };
224        crate::protocol_serde::type_erase_result(parse_result)
225    }
226}
227#[derive(Debug)]
228struct DescribeFileSystemsRequestSerializer;
229impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeFileSystemsRequestSerializer {
230    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
231    fn serialize_input(
232        &self,
233        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
234        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
235    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
236        let input = input
237            .downcast::<crate::operation::describe_file_systems::DescribeFileSystemsInput>()
238            .expect("correct type");
239        let _header_serialization_settings = _cfg
240            .load::<crate::serialization_settings::HeaderSerializationSettings>()
241            .cloned()
242            .unwrap_or_default();
243        let mut request_builder = {
244            #[allow(clippy::uninlined_format_args)]
245            fn uri_base(
246                _input: &crate::operation::describe_file_systems::DescribeFileSystemsInput,
247                output: &mut ::std::string::String,
248            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
249                use ::std::fmt::Write as _;
250                ::std::write!(output, "/2015-02-01/file-systems").expect("formatting should succeed");
251                ::std::result::Result::Ok(())
252            }
253            fn uri_query(
254                _input: &crate::operation::describe_file_systems::DescribeFileSystemsInput,
255                mut output: &mut ::std::string::String,
256            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
257                let mut query = ::aws_smithy_http::query::Writer::new(output);
258                if let ::std::option::Option::Some(inner_1) = &_input.max_items {
259                    {
260                        query.push_kv("MaxItems", ::aws_smithy_types::primitive::Encoder::from(*inner_1).encode());
261                    }
262                }
263                if let ::std::option::Option::Some(inner_2) = &_input.marker {
264                    {
265                        query.push_kv("Marker", &::aws_smithy_http::query::fmt_string(inner_2));
266                    }
267                }
268                if let ::std::option::Option::Some(inner_3) = &_input.creation_token {
269                    {
270                        query.push_kv("CreationToken", &::aws_smithy_http::query::fmt_string(inner_3));
271                    }
272                }
273                if let ::std::option::Option::Some(inner_4) = &_input.file_system_id {
274                    {
275                        query.push_kv("FileSystemId", &::aws_smithy_http::query::fmt_string(inner_4));
276                    }
277                }
278                ::std::result::Result::Ok(())
279            }
280            #[allow(clippy::unnecessary_wraps)]
281            fn update_http_builder(
282                input: &crate::operation::describe_file_systems::DescribeFileSystemsInput,
283                builder: ::http_1x::request::Builder,
284            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
285                let mut uri = ::std::string::String::new();
286                uri_base(input, &mut uri)?;
287                uri_query(input, &mut uri)?;
288                ::std::result::Result::Ok(builder.method("GET").uri(uri))
289            }
290            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
291            builder
292        };
293        let body = ::aws_smithy_types::body::SdkBody::from("");
294
295        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
296    }
297}
298#[derive(Debug)]
299struct DescribeFileSystemsEndpointParamsInterceptor;
300
301#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
302impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeFileSystemsEndpointParamsInterceptor {
303    fn name(&self) -> &'static str {
304        "DescribeFileSystemsEndpointParamsInterceptor"
305    }
306
307    fn read_before_execution(
308        &self,
309        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
310            '_,
311            ::aws_smithy_runtime_api::client::interceptors::context::Input,
312            ::aws_smithy_runtime_api::client::interceptors::context::Output,
313            ::aws_smithy_runtime_api::client::interceptors::context::Error,
314        >,
315        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
316    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
317        let _input = context
318            .input()
319            .downcast_ref::<DescribeFileSystemsInput>()
320            .ok_or("failed to downcast to DescribeFileSystemsInput")?;
321
322        let params = crate::config::endpoint::Params::builder()
323            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
324            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
325            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
326            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
327            .build()
328            .map_err(|err| {
329                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
330            })?;
331        cfg.interceptor_state()
332            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
333        ::std::result::Result::Ok(())
334    }
335}
336
337// The get_* functions below are generated from JMESPath expressions in the
338// operationContextParams trait. They target the operation's input shape.
339
340/// Error type for the `DescribeFileSystemsError` operation.
341#[non_exhaustive]
342#[derive(::std::fmt::Debug)]
343pub enum DescribeFileSystemsError {
344    /// <p>Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.</p>
345    BadRequest(crate::types::error::BadRequest),
346    /// <p>Returned if the specified <code>FileSystemId</code> value doesn't exist in the requester's Amazon Web Services account.</p>
347    FileSystemNotFound(crate::types::error::FileSystemNotFound),
348    /// <p>Returned if an error occurred on the server side.</p>
349    InternalServerError(crate::types::error::InternalServerError),
350    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
351    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
352    variable wildcard pattern and check `.code()`:
353     \
354    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
355     \
356    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeFileSystemsError) for what information is available for the error.")]
357    Unhandled(crate::error::sealed_unhandled::Unhandled),
358}
359impl DescribeFileSystemsError {
360    /// Creates the `DescribeFileSystemsError::Unhandled` variant from any error type.
361    pub fn unhandled(
362        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
363    ) -> Self {
364        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
365            source: err.into(),
366            meta: ::std::default::Default::default(),
367        })
368    }
369
370    /// Creates the `DescribeFileSystemsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
371    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
372        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
373            source: err.clone().into(),
374            meta: err,
375        })
376    }
377    ///
378    /// Returns error metadata, which includes the error code, message,
379    /// request ID, and potentially additional information.
380    ///
381    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
382        match self {
383            Self::BadRequest(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
384            Self::FileSystemNotFound(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
385            Self::InternalServerError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
386            Self::Unhandled(e) => &e.meta,
387        }
388    }
389    /// Returns `true` if the error kind is `DescribeFileSystemsError::BadRequest`.
390    pub fn is_bad_request(&self) -> bool {
391        matches!(self, Self::BadRequest(_))
392    }
393    /// Returns `true` if the error kind is `DescribeFileSystemsError::FileSystemNotFound`.
394    pub fn is_file_system_not_found(&self) -> bool {
395        matches!(self, Self::FileSystemNotFound(_))
396    }
397    /// Returns `true` if the error kind is `DescribeFileSystemsError::InternalServerError`.
398    pub fn is_internal_server_error(&self) -> bool {
399        matches!(self, Self::InternalServerError(_))
400    }
401}
402impl ::std::error::Error for DescribeFileSystemsError {
403    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
404        match self {
405            Self::BadRequest(_inner) => ::std::option::Option::Some(_inner),
406            Self::FileSystemNotFound(_inner) => ::std::option::Option::Some(_inner),
407            Self::InternalServerError(_inner) => ::std::option::Option::Some(_inner),
408            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
409        }
410    }
411}
412impl ::std::fmt::Display for DescribeFileSystemsError {
413    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
414        match self {
415            Self::BadRequest(_inner) => _inner.fmt(f),
416            Self::FileSystemNotFound(_inner) => _inner.fmt(f),
417            Self::InternalServerError(_inner) => _inner.fmt(f),
418            Self::Unhandled(_inner) => {
419                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
420                    write!(f, "unhandled error ({code})")
421                } else {
422                    f.write_str("unhandled error")
423                }
424            }
425        }
426    }
427}
428impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeFileSystemsError {
429    fn code(&self) -> ::std::option::Option<&str> {
430        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
431    }
432    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
433        ::std::option::Option::None
434    }
435}
436impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeFileSystemsError {
437    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
438        match self {
439            Self::BadRequest(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
440            Self::FileSystemNotFound(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
441            Self::InternalServerError(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
442            Self::Unhandled(_inner) => &_inner.meta,
443        }
444    }
445}
446impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeFileSystemsError {
447    fn create_unhandled_error(
448        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
449        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
450    ) -> Self {
451        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
452            source,
453            meta: meta.unwrap_or_default(),
454        })
455    }
456}
457impl ::aws_types::request_id::RequestId for crate::operation::describe_file_systems::DescribeFileSystemsError {
458    fn request_id(&self) -> Option<&str> {
459        self.meta().request_id()
460    }
461}
462
463pub use crate::operation::describe_file_systems::_describe_file_systems_input::DescribeFileSystemsInput;
464
465pub use crate::operation::describe_file_systems::_describe_file_systems_output::DescribeFileSystemsOutput;
466
467mod _describe_file_systems_input;
468
469mod _describe_file_systems_output;
470
471/// Builders
472pub mod builders;
473
474/// Paginator for this operation
475pub mod paginator;
aws_sdk_efs/operation/describe_file_systems.rs

aws_sdk_efs/operation/
describe_file_systems.rs
