aws_sdk_pipes/operation/
list_pipes.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `ListPipes`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ListPipes;
6impl ListPipes {
7    /// Creates a new `ListPipes`
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_pipes::ListPipesInput,
14    ) -> ::std::result::Result<
15        crate::operation::list_pipes::ListPipesOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::list_pipes::ListPipesError,
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_pipes::ListPipesError>()
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_pipes::ListPipesOutput>()
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_pipes::ListPipesInput,
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("Pipes", "ListPipes", 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                "Pipes.ListPipes",
59                "rpc.service" = "Pipes",
60                "rpc.method" = "ListPipes",
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 ListPipes {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListPipes");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            ListPipesRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            ListPipesResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("ListPipes")
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("ListPipes", "Pipes"));
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("ListPipes")
127            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
128            .with_interceptor(ListPipesEndpointParamsInterceptor)
129            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
130                crate::operation::list_pipes::ListPipesError,
131            >::new())
132            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
133                crate::operation::list_pipes::ListPipesError,
134            >::new())
135            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
136                crate::operation::list_pipes::ListPipesError,
137            >::new());
138
139        ::std::borrow::Cow::Owned(rcb)
140    }
141}
142
143#[derive(Debug)]
144struct ListPipesResponseDeserializer;
145impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListPipesResponseDeserializer {
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_pipes::de_list_pipes_http_error(status, headers, body)
158        } else {
159            crate::protocol_serde::shape_list_pipes::de_list_pipes_http_response(status, headers, body)
160        };
161        crate::protocol_serde::type_erase_result(parse_result)
162    }
163}
164#[derive(Debug)]
165struct ListPipesRequestSerializer;
166impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListPipesRequestSerializer {
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.downcast::<crate::operation::list_pipes::ListPipesInput>().expect("correct type");
174        let _header_serialization_settings = _cfg
175            .load::<crate::serialization_settings::HeaderSerializationSettings>()
176            .cloned()
177            .unwrap_or_default();
178        let mut request_builder = {
179            fn uri_base(
180                _input: &crate::operation::list_pipes::ListPipesInput,
181                output: &mut ::std::string::String,
182            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
183                use ::std::fmt::Write as _;
184                ::std::write!(output, "/v1/pipes").expect("formatting should succeed");
185                ::std::result::Result::Ok(())
186            }
187            fn uri_query(
188                _input: &crate::operation::list_pipes::ListPipesInput,
189                mut output: &mut ::std::string::String,
190            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
191                let mut query = ::aws_smithy_http::query::Writer::new(output);
192                if let ::std::option::Option::Some(inner_1) = &_input.name_prefix {
193                    {
194                        query.push_kv("NamePrefix", &::aws_smithy_http::query::fmt_string(inner_1));
195                    }
196                }
197                if let ::std::option::Option::Some(inner_2) = &_input.desired_state {
198                    {
199                        query.push_kv("DesiredState", &::aws_smithy_http::query::fmt_string(inner_2));
200                    }
201                }
202                if let ::std::option::Option::Some(inner_3) = &_input.current_state {
203                    {
204                        query.push_kv("CurrentState", &::aws_smithy_http::query::fmt_string(inner_3));
205                    }
206                }
207                if let ::std::option::Option::Some(inner_4) = &_input.source_prefix {
208                    {
209                        query.push_kv("SourcePrefix", &::aws_smithy_http::query::fmt_string(inner_4));
210                    }
211                }
212                if let ::std::option::Option::Some(inner_5) = &_input.target_prefix {
213                    {
214                        query.push_kv("TargetPrefix", &::aws_smithy_http::query::fmt_string(inner_5));
215                    }
216                }
217                if let ::std::option::Option::Some(inner_6) = &_input.next_token {
218                    {
219                        query.push_kv("NextToken", &::aws_smithy_http::query::fmt_string(inner_6));
220                    }
221                }
222                if let ::std::option::Option::Some(inner_7) = &_input.limit {
223                    {
224                        query.push_kv("Limit", ::aws_smithy_types::primitive::Encoder::from(*inner_7).encode());
225                    }
226                }
227                ::std::result::Result::Ok(())
228            }
229            #[allow(clippy::unnecessary_wraps)]
230            fn update_http_builder(
231                input: &crate::operation::list_pipes::ListPipesInput,
232                builder: ::http::request::Builder,
233            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
234                let mut uri = ::std::string::String::new();
235                uri_base(input, &mut uri)?;
236                uri_query(input, &mut uri)?;
237                ::std::result::Result::Ok(builder.method("GET").uri(uri))
238            }
239            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
240            builder
241        };
242        let body = ::aws_smithy_types::body::SdkBody::from("");
243
244        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
245    }
246}
247#[derive(Debug)]
248struct ListPipesEndpointParamsInterceptor;
249
250impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListPipesEndpointParamsInterceptor {
251    fn name(&self) -> &'static str {
252        "ListPipesEndpointParamsInterceptor"
253    }
254
255    fn read_before_execution(
256        &self,
257        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
258            '_,
259            ::aws_smithy_runtime_api::client::interceptors::context::Input,
260            ::aws_smithy_runtime_api::client::interceptors::context::Output,
261            ::aws_smithy_runtime_api::client::interceptors::context::Error,
262        >,
263        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
264    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
265        let _input = context
266            .input()
267            .downcast_ref::<ListPipesInput>()
268            .ok_or("failed to downcast to ListPipesInput")?;
269
270        let params = crate::config::endpoint::Params::builder()
271            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
272            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
273            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
274            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
275            .build()
276            .map_err(|err| {
277                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
278            })?;
279        cfg.interceptor_state()
280            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
281        ::std::result::Result::Ok(())
282    }
283}
284
285// The get_* functions below are generated from JMESPath expressions in the
286// operationContextParams trait. They target the operation's input shape.
287
288/// Error type for the `ListPipesError` operation.
289#[non_exhaustive]
290#[derive(::std::fmt::Debug)]
291pub enum ListPipesError {
292    /// <p>This exception occurs due to unexpected causes.</p>
293    InternalException(crate::types::error::InternalException),
294    /// <p>An action was throttled.</p>
295    ThrottlingException(crate::types::error::ThrottlingException),
296    /// <p>Indicates that an error has occurred while performing a validate operation.</p>
297    ValidationException(crate::types::error::ValidationException),
298    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
299    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
300    variable wildcard pattern and check `.code()`:
301     \
302    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
303     \
304    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListPipesError) for what information is available for the error.")]
305    Unhandled(crate::error::sealed_unhandled::Unhandled),
306}
307impl ListPipesError {
308    /// Creates the `ListPipesError::Unhandled` variant from any error type.
309    pub fn unhandled(
310        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
311    ) -> Self {
312        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
313            source: err.into(),
314            meta: ::std::default::Default::default(),
315        })
316    }
317
318    /// Creates the `ListPipesError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
319    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
320        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
321            source: err.clone().into(),
322            meta: err,
323        })
324    }
325    ///
326    /// Returns error metadata, which includes the error code, message,
327    /// request ID, and potentially additional information.
328    ///
329    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
330        match self {
331            Self::InternalException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
332            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
333            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
334            Self::Unhandled(e) => &e.meta,
335        }
336    }
337    /// Returns `true` if the error kind is `ListPipesError::InternalException`.
338    pub fn is_internal_exception(&self) -> bool {
339        matches!(self, Self::InternalException(_))
340    }
341    /// Returns `true` if the error kind is `ListPipesError::ThrottlingException`.
342    pub fn is_throttling_exception(&self) -> bool {
343        matches!(self, Self::ThrottlingException(_))
344    }
345    /// Returns `true` if the error kind is `ListPipesError::ValidationException`.
346    pub fn is_validation_exception(&self) -> bool {
347        matches!(self, Self::ValidationException(_))
348    }
349}
350impl ::std::error::Error for ListPipesError {
351    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
352        match self {
353            Self::InternalException(_inner) => ::std::option::Option::Some(_inner),
354            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
355            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
356            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
357        }
358    }
359}
360impl ::std::fmt::Display for ListPipesError {
361    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
362        match self {
363            Self::InternalException(_inner) => _inner.fmt(f),
364            Self::ThrottlingException(_inner) => _inner.fmt(f),
365            Self::ValidationException(_inner) => _inner.fmt(f),
366            Self::Unhandled(_inner) => {
367                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
368                    write!(f, "unhandled error ({code})")
369                } else {
370                    f.write_str("unhandled error")
371                }
372            }
373        }
374    }
375}
376impl ::aws_smithy_types::retry::ProvideErrorKind for ListPipesError {
377    fn code(&self) -> ::std::option::Option<&str> {
378        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
379    }
380    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
381        ::std::option::Option::None
382    }
383}
384impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListPipesError {
385    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
386        match self {
387            Self::InternalException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
388            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
389            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
390            Self::Unhandled(_inner) => &_inner.meta,
391        }
392    }
393}
394impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListPipesError {
395    fn create_unhandled_error(
396        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
397        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
398    ) -> Self {
399        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
400            source,
401            meta: meta.unwrap_or_default(),
402        })
403    }
404}
405impl ::aws_types::request_id::RequestId for crate::operation::list_pipes::ListPipesError {
406    fn request_id(&self) -> Option<&str> {
407        self.meta().request_id()
408    }
409}
410
411pub use crate::operation::list_pipes::_list_pipes_output::ListPipesOutput;
412
413pub use crate::operation::list_pipes::_list_pipes_input::ListPipesInput;
414
415mod _list_pipes_input;
416
417mod _list_pipes_output;
418
419/// Builders
420pub mod builders;
421
422/// Paginator for this operation
423pub mod paginator;