aws_sdk_mediaconnect/operation/
list_gateway_instances.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `ListGatewayInstances`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ListGatewayInstances;
6impl ListGatewayInstances {
7    /// Creates a new `ListGatewayInstances`
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_gateway_instances::ListGatewayInstancesInput,
14    ) -> ::std::result::Result<
15        crate::operation::list_gateway_instances::ListGatewayInstancesOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::list_gateway_instances::ListGatewayInstancesError,
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_gateway_instances::ListGatewayInstancesError>()
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_gateway_instances::ListGatewayInstancesOutput>()
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_gateway_instances::ListGatewayInstancesInput,
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("MediaConnect", "ListGatewayInstances", 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                "MediaConnect.ListGatewayInstances",
59                "rpc.service" = "MediaConnect",
60                "rpc.method" = "ListGatewayInstances",
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 ListGatewayInstances {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListGatewayInstances");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            ListGatewayInstancesRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            ListGatewayInstancesResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("ListGatewayInstances")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "ListGatewayInstances",
107            "MediaConnect",
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("ListGatewayInstances")
129            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
130            .with_interceptor(ListGatewayInstancesEndpointParamsInterceptor)
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
132                crate::operation::list_gateway_instances::ListGatewayInstancesError,
133            >::new())
134            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
135                crate::operation::list_gateway_instances::ListGatewayInstancesError,
136            >::new())
137            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
138                crate::operation::list_gateway_instances::ListGatewayInstancesError,
139            >::new());
140
141        ::std::borrow::Cow::Owned(rcb)
142    }
143}
144
145#[derive(Debug)]
146struct ListGatewayInstancesResponseDeserializer;
147impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListGatewayInstancesResponseDeserializer {
148    fn deserialize_nonstreaming(
149        &self,
150        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
151    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
152        let (success, status) = (response.status().is_success(), response.status().as_u16());
153        let headers = response.headers();
154        let body = response.body().bytes().expect("body loaded");
155        #[allow(unused_mut)]
156        let mut force_error = false;
157        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
158        let parse_result = if !success && status != 200 || force_error {
159            crate::protocol_serde::shape_list_gateway_instances::de_list_gateway_instances_http_error(status, headers, body)
160        } else {
161            crate::protocol_serde::shape_list_gateway_instances::de_list_gateway_instances_http_response(status, headers, body)
162        };
163        crate::protocol_serde::type_erase_result(parse_result)
164    }
165}
166#[derive(Debug)]
167struct ListGatewayInstancesRequestSerializer;
168impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListGatewayInstancesRequestSerializer {
169    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
170    fn serialize_input(
171        &self,
172        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
173        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
174    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
175        let input = input
176            .downcast::<crate::operation::list_gateway_instances::ListGatewayInstancesInput>()
177            .expect("correct type");
178        let _header_serialization_settings = _cfg
179            .load::<crate::serialization_settings::HeaderSerializationSettings>()
180            .cloned()
181            .unwrap_or_default();
182        let mut request_builder = {
183            fn uri_base(
184                _input: &crate::operation::list_gateway_instances::ListGatewayInstancesInput,
185                output: &mut ::std::string::String,
186            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
187                use ::std::fmt::Write as _;
188                ::std::write!(output, "/v1/gateway-instances").expect("formatting should succeed");
189                ::std::result::Result::Ok(())
190            }
191            fn uri_query(
192                _input: &crate::operation::list_gateway_instances::ListGatewayInstancesInput,
193                mut output: &mut ::std::string::String,
194            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
195                let mut query = ::aws_smithy_http::query::Writer::new(output);
196                if let ::std::option::Option::Some(inner_1) = &_input.filter_arn {
197                    {
198                        query.push_kv("filterArn", &::aws_smithy_http::query::fmt_string(inner_1));
199                    }
200                }
201                if let ::std::option::Option::Some(inner_2) = &_input.max_results {
202                    {
203                        query.push_kv("maxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_2).encode());
204                    }
205                }
206                if let ::std::option::Option::Some(inner_3) = &_input.next_token {
207                    {
208                        query.push_kv("nextToken", &::aws_smithy_http::query::fmt_string(inner_3));
209                    }
210                }
211                ::std::result::Result::Ok(())
212            }
213            #[allow(clippy::unnecessary_wraps)]
214            fn update_http_builder(
215                input: &crate::operation::list_gateway_instances::ListGatewayInstancesInput,
216                builder: ::http::request::Builder,
217            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
218                let mut uri = ::std::string::String::new();
219                uri_base(input, &mut uri)?;
220                uri_query(input, &mut uri)?;
221                ::std::result::Result::Ok(builder.method("GET").uri(uri))
222            }
223            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
224            builder
225        };
226        let body = ::aws_smithy_types::body::SdkBody::from("");
227
228        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
229    }
230}
231#[derive(Debug)]
232struct ListGatewayInstancesEndpointParamsInterceptor;
233
234impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListGatewayInstancesEndpointParamsInterceptor {
235    fn name(&self) -> &'static str {
236        "ListGatewayInstancesEndpointParamsInterceptor"
237    }
238
239    fn read_before_execution(
240        &self,
241        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
242            '_,
243            ::aws_smithy_runtime_api::client::interceptors::context::Input,
244            ::aws_smithy_runtime_api::client::interceptors::context::Output,
245            ::aws_smithy_runtime_api::client::interceptors::context::Error,
246        >,
247        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
248    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
249        let _input = context
250            .input()
251            .downcast_ref::<ListGatewayInstancesInput>()
252            .ok_or("failed to downcast to ListGatewayInstancesInput")?;
253
254        let params = crate::config::endpoint::Params::builder()
255            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
256            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
257            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
258            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
259            .build()
260            .map_err(|err| {
261                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
262            })?;
263        cfg.interceptor_state()
264            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
265        ::std::result::Result::Ok(())
266    }
267}
268
269// The get_* functions below are generated from JMESPath expressions in the
270// operationContextParams trait. They target the operation's input shape.
271
272/// Error type for the `ListGatewayInstancesError` operation.
273#[non_exhaustive]
274#[derive(::std::fmt::Debug)]
275pub enum ListGatewayInstancesError {
276    /// <p>This exception is thrown if the request contains a semantic error. The precise meaning depends on the API, and is documented in the error message.</p>
277    BadRequestException(crate::types::error::BadRequestException),
278    /// <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>
279    ConflictException(crate::types::error::ConflictException),
280    /// <p>The server encountered an internal error and is unable to complete the request.</p>
281    InternalServerErrorException(crate::types::error::InternalServerErrorException),
282    /// <p>The service is currently unavailable or busy.</p>
283    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
284    /// <p>The request was denied due to request throttling.</p>
285    TooManyRequestsException(crate::types::error::TooManyRequestsException),
286    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
287    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
288    variable wildcard pattern and check `.code()`:
289     \
290    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
291     \
292    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListGatewayInstancesError) for what information is available for the error.")]
293    Unhandled(crate::error::sealed_unhandled::Unhandled),
294}
295impl ListGatewayInstancesError {
296    /// Creates the `ListGatewayInstancesError::Unhandled` variant from any error type.
297    pub fn unhandled(
298        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
299    ) -> Self {
300        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
301            source: err.into(),
302            meta: ::std::default::Default::default(),
303        })
304    }
305
306    /// Creates the `ListGatewayInstancesError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
307    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
308        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
309            source: err.clone().into(),
310            meta: err,
311        })
312    }
313    ///
314    /// Returns error metadata, which includes the error code, message,
315    /// request ID, and potentially additional information.
316    ///
317    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
318        match self {
319            Self::BadRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
320            Self::ConflictException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
321            Self::InternalServerErrorException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
322            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
323            Self::TooManyRequestsException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
324            Self::Unhandled(e) => &e.meta,
325        }
326    }
327    /// Returns `true` if the error kind is `ListGatewayInstancesError::BadRequestException`.
328    pub fn is_bad_request_exception(&self) -> bool {
329        matches!(self, Self::BadRequestException(_))
330    }
331    /// Returns `true` if the error kind is `ListGatewayInstancesError::ConflictException`.
332    pub fn is_conflict_exception(&self) -> bool {
333        matches!(self, Self::ConflictException(_))
334    }
335    /// Returns `true` if the error kind is `ListGatewayInstancesError::InternalServerErrorException`.
336    pub fn is_internal_server_error_exception(&self) -> bool {
337        matches!(self, Self::InternalServerErrorException(_))
338    }
339    /// Returns `true` if the error kind is `ListGatewayInstancesError::ServiceUnavailableException`.
340    pub fn is_service_unavailable_exception(&self) -> bool {
341        matches!(self, Self::ServiceUnavailableException(_))
342    }
343    /// Returns `true` if the error kind is `ListGatewayInstancesError::TooManyRequestsException`.
344    pub fn is_too_many_requests_exception(&self) -> bool {
345        matches!(self, Self::TooManyRequestsException(_))
346    }
347}
348impl ::std::error::Error for ListGatewayInstancesError {
349    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
350        match self {
351            Self::BadRequestException(_inner) => ::std::option::Option::Some(_inner),
352            Self::ConflictException(_inner) => ::std::option::Option::Some(_inner),
353            Self::InternalServerErrorException(_inner) => ::std::option::Option::Some(_inner),
354            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
355            Self::TooManyRequestsException(_inner) => ::std::option::Option::Some(_inner),
356            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
357        }
358    }
359}
360impl ::std::fmt::Display for ListGatewayInstancesError {
361    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
362        match self {
363            Self::BadRequestException(_inner) => _inner.fmt(f),
364            Self::ConflictException(_inner) => _inner.fmt(f),
365            Self::InternalServerErrorException(_inner) => _inner.fmt(f),
366            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
367            Self::TooManyRequestsException(_inner) => _inner.fmt(f),
368            Self::Unhandled(_inner) => {
369                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
370                    write!(f, "unhandled error ({code})")
371                } else {
372                    f.write_str("unhandled error")
373                }
374            }
375        }
376    }
377}
378impl ::aws_smithy_types::retry::ProvideErrorKind for ListGatewayInstancesError {
379    fn code(&self) -> ::std::option::Option<&str> {
380        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
381    }
382    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
383        match self {
384            Self::ConflictException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
385            Self::InternalServerErrorException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
386            Self::ServiceUnavailableException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
387            Self::TooManyRequestsException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
388            _ => ::std::option::Option::None,
389        }
390    }
391}
392impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListGatewayInstancesError {
393    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
394        match self {
395            Self::BadRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
396            Self::ConflictException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
397            Self::InternalServerErrorException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
398            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
399            Self::TooManyRequestsException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
400            Self::Unhandled(_inner) => &_inner.meta,
401        }
402    }
403}
404impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListGatewayInstancesError {
405    fn create_unhandled_error(
406        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
407        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
408    ) -> Self {
409        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
410            source,
411            meta: meta.unwrap_or_default(),
412        })
413    }
414}
415impl ::aws_types::request_id::RequestId for crate::operation::list_gateway_instances::ListGatewayInstancesError {
416    fn request_id(&self) -> Option<&str> {
417        self.meta().request_id()
418    }
419}
420
421pub use crate::operation::list_gateway_instances::_list_gateway_instances_output::ListGatewayInstancesOutput;
422
423pub use crate::operation::list_gateway_instances::_list_gateway_instances_input::ListGatewayInstancesInput;
424
425mod _list_gateway_instances_input;
426
427mod _list_gateway_instances_output;
428
429/// Builders
430pub mod builders;
431
432/// Paginator for this operation
433pub mod paginator;